dev-markdown_check

Validate and correct Markdown formatting, syntax, and structure with Python scripts and linters.

Updated Jan 28, 2026
One-click install
npx skills add https://github.com/zhizhunbao/ai-dev-config --skill dev-markdown-check-zhizhunbao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dev-markdown_check
Source: https://github.com/zhizhunbao/ai-dev-config/tree/main/core/skills/dev-markdown_check
Command: npx skills add https://github.com/zhizhunbao/ai-dev-config --skill dev-markdown-check-zhizhunbao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the common issues of poorly formatted, syntactically incorrect, or structurally unsound Markdown documents, ensuring clarity and consistency.

Core Features & Use Cases

  • Syntax Validation: Checks for common Markdown syntax errors.
  • Structure Verification: Ensures proper heading hierarchy and list formatting.
  • Link Checking: Identifies broken or incorrect links within documents.
  • Formatting Fixes: Automatically corrects trailing whitespace and list indentation.
  • Use Case: After generating a README file for a new project, use this Skill to automatically validate its formatting, check for broken links, and ensure it adheres to best practices before committing.

Quick Start

Run the markdown check skill on the file named 'README.md' to validate its formatting and identify any issues.

Frequently Asked Questions about dev-markdown_check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate markdown formatting and fix syntax errors in a README?

To validate markdown formatting, use this Skill to run Python scripts and linters like markdownlint and remark. It identifies syntax errors, checks heading hierarchy, and automatically fixes issues such as trailing whitespace and list indentation to ensure document correctness.

What is the best way to check for broken links and incorrect markdown structure?

The best way to check for broken links and incorrect markdown structure is using this Skill's link checking and structure verification features. It identifies broken links and ensures proper heading hierarchy and list formatting to maintain document quality.

Can I automatically correct trailing whitespace and list indentation in markdown files?

Yes, you can automatically correct trailing whitespace and list indentation in markdown files. This Skill supports automated fixing to address these specific formatting issues alongside providing detailed reports for overall quality assurance.

Does markdownlint work with Python scripts for structural verification?

Yes, markdownlint works with Python scripts in this Skill to perform structural verification. They combine to validate markdown syntax, ensure proper heading hierarchy, check for broken links, and generate detailed quality assurance reports.

Why does my markdown heading hierarchy fail validation checks?

Your markdown heading hierarchy fails validation checks when it contains skipped levels or improper nesting. This Skill uses remark and markdownlint to verify structure, identifies these formatting issues, and supports automated fixing to restore correct hierarchy.

How do I generate a detailed quality assurance report for markdown documentation?

To generate a detailed quality assurance report for markdown documentation, run this Skill on your target files. It validates syntax, checks links, and outputs comprehensive reports detailing any formatting or structural issues found during the linter checks.