markdown-formatter

Formats Markdown documents to enforce consistent style and structure.

22|2|Updated Nov 22, 2025
One-click install
npx skills add https://github.com/markpitt/claude-skills --skill markdown-formatter-markpitt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-formatter
Source: https://github.com/markpitt/claude-skills/tree/main/skills/markdown-formatter
Command: npx skills add https://github.com/markpitt/claude-skills --skill markdown-formatter-markpitt

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill provides modular, category-based guidance to format and polish Markdown documents, improving readability and consistency.

Core Features & Use Cases

  • Phase-based formatting for headers, lists, code, links, images, and spacing
  • Quick reference navigation and resource indexing
  • Validation checks and automated improvements
  • Ready-to-run templates for validation and formatting

Quick Start

Load headers-hierarchy.md for header rules, then proceed to lists-nesting.md, code-emphasis.md, links-images.md, and spacing-tables.md for a complete polish workflow.

Frequently Asked Questions about markdown-formatter

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

FAQPage Schema
How do I format markdown documents for consistent style and readability?

Markdown formatting enforces consistent style across headers, lists, code blocks, links, and images. This Skill applies ATX header usage, fenced code blocks with language identifiers, consistent list markers, descriptive link text, spacing rules, and validation workflows to polish technical documentation, READMEs, and knowledge bases into readable, standardized docs.

What markdown style rules should I follow for headers and code blocks?

Follow ATX header syntax for headers and use fenced code blocks with language identifiers for code samples. This Skill guides you through header hierarchy rules, then proceeds to lists, code emphasis, links, images, and spacing to create a complete formatting workflow that meets documentation standards.

Can I validate and automatically improve markdown documents?

Yes. This Skill includes validation checks and automated improvements that assess headers, lists, code blocks, links, images, and spacing against style requirements. Ready-to-run templates support both validation and formatting workflows for consistent technical documentation.

What should I include in link text and image alt text in markdown?

Use descriptive link text and descriptive alt text for images. This Skill enforces these requirements as part of its formatting phase, ensuring links and images communicate their purpose clearly and improve accessibility across READMEs, API references, and knowledge bases.

Do I need to restructure my markdown before formatting, or can I start immediately?

Start immediately with phase-based formatting. Load the headers-hierarchy module first, then proceed through lists, code, links, images, and spacing templates in sequence. No prerequisite restructuring is needed; the Skill guides you through a complete polish workflow.

What's the difference between linting and formatting markdown?

Linting identifies style violations; formatting applies corrections and enforces consistency. This Skill combines both—it validates markdown against style rules and automatically improves structure, spacing, and element consistency across technical documentation.