markdown-formatter

Name: markdown-formatter
Availability: InStock
Author: doctorduke

Lints and repairs Markdown filesGitHub-style, including accessibility and formatting checks.

Updated Aug 23, 2026

Search Tags:#linting #documentation #technical writing #formatting #style guide #Markdown

Ready to run

npx skills add https://github.com/doctorduke/seashells --skill markdown-formatter

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-formatter
Source: https://github.com/doctorduke/seashells/tree/main/.claude/skills/markdown-formatter
Command: npx skills add https://github.com/doctorduke/seashells --skill markdown-formatter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures all your Markdown documents maintain a consistent style and structure, eliminating manual formatting errors and saving you time on documentation review and maintenance. It automatically checks for common issues like broken links and inconsistent hierarchy.

Core Features & Use Cases

Consistent Formatting: Automatically applies rules for heading hierarchy, list indentation, and code block language tags.
Link Validation: Checks for broken internal links, empty links, and missing alt text on images.
Syntax Linting: Validates Markdown syntax to prevent rendering issues and ensure readability.
Use Case: Use it to automatically format your project's README.md, CONTRIBUTING.md, or an entire docs/ directory, ensuring every file adheres to your team's style guide without manual intervention.

Quick Start

Example of desired Markdown structure

The skill will ensure your files match this consistent style.

Main Title

Section

Subsection

Regular paragraph text.

List item 1
- Nested item
List item 2

def example():
    return "formatted"

Link text

Frequently Asked Questions about markdown-formatter

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

FAQPage Schema

How do I automatically format and lint Markdown documents?▼

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.

What Markdown style rules does the formatter enforce?▼

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.

Can I use this to check my README and documentation files for broken links?▼

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.

How do I ensure consistent Markdown style across my entire docs directory?▼

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.

What happens if my Markdown doesn't follow the style guide?▼

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.