markdown-formatter

Markdown formatting and linting automatically applies consistent style rules to your documents, enforcing heading hierarchy, list indentation, code block language tags, and link syntax. It validates syntax, checks for broken links and missing alt text, and reports issues or outputs the corrected file.

The formatter enforces ATX heading hierarchy, 2-space list indentation, required language tags on code blocks, reference-style links, alt text on images, and line-length guidance of 80–120 characters. It also validates internal and external links and checks for syntax errors.

Yes, the formatter validates both internal and external links across your Markdown files. It detects broken internal links, empty links, and missing alt text on images, reporting all issues so you can fix them before publishing your documentation.

Run the formatter on your entire docs directory to apply consistent formatting rules across all Markdown files at once. It enforces the same heading hierarchy, indentation, code block tags, and link structure project-wide without manual intervention.

The formatter either auto-corrects your Markdown to match the style guide or generates a detailed report of all violations. You receive either the corrected file or a list of issues including heading problems, indentation errors, missing language tags, and broken links.