markdown-formatter

Format and lint Markdown documents with heading, list, code block, and link rules.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/dredd-us/seashells --skill markdown-formatter-dredd-us
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-formatter
Source: https://github.com/dredd-us/seashells/tree/main/.claude/skills/markdown-formatter
Command: npx skills add https://github.com/dredd-us/seashells --skill markdown-formatter-dredd-us

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures all your Markdown documents, from READMEs to extensive documentation, maintain consistent style, proper structure, and validate against common issues like broken links, saving you time on manual review.

Core Features & Use Cases

  • Consistent Formatting: Applies standard rules for headings, lists, code blocks, and links.
  • Link Validation: Automatically checks for broken internal links and empty links.
  • Use Case: Before committing a new feature's documentation, use this skill to automatically format the README.md and ensure all internal links are valid and images have alt text.

Quick Start

Use the markdown-formatter skill to format the file 'docs/new_feature.md' and report any issues.

Frequently Asked Questions about markdown-formatter

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

FAQPage Schema
How do I format and lint Markdown documents to enforce consistent style?

Markdown formatting enforces consistent style across documents by applying standard rules for headings, lists, code blocks, and links. It validates heading hierarchy, ensures 2-space list indentation, requires language tags on code blocks, checks reference-style links, and flags line length issues between 80-120 characters.

Can I validate broken links and missing alt text in my documentation?

Yes, the formatter automatically detects broken internal links, empty links, and missing alt text on images. This catches documentation issues before publishing, ensuring all references are valid and images are accessible.

What Markdown formatting rules does this tool enforce?

The tool enforces ATX heading formatting, 2-space list indentation, language-tagged code blocks, reference-style links, 80-120 character line length guidance, broken link detection, and missing alt-text checks across README and documentation files.

How do I use this before committing documentation changes?

Apply the formatter to your Markdown files like README.md or docs/ before committing. It automatically formats content to enforce style rules and reports issues like broken links and missing alt text, reducing manual review time.

Does this work with technical documentation projects?

Yes, it's designed for README files, technical documentation, and documentation projects. It handles multiple files, enforces consistent structure and style across your entire documentation set, and ensures compliance with technical writing standards.

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

The tool identifies violations like incorrect heading hierarchy, inconsistent indentation, missing code block languages, and inline links instead of reference-style. It reports all issues, allowing you to review and fix formatting to meet documentation standards.