markdown-formatter_skill

Overview

This skill formats and structures content into clean, well-organized Markdown for documentation, READMEs, API references, and notes. It enforces consistent heading hierarchy, code block syntax, lists, and tables to produce readable, reusable Markdown output.

How this skill works

The formatter analyzes raw text to detect titles, section breaks, lists, code samples, and tabular data. It maps structure to ATX headings, converts code to fenced blocks with language identifiers, transforms sequences into numbered lists and related items into bullets, and generates Markdown tables for structured data. It also applies style rules like line-length limits, blank lines between sections, and limits on heading depth and nesting.

When to use it

• Creating or polishing documentation and READMEs
• Converting notes, transcripts, or unstructured text into Markdown
• Formatting API docs, function signatures, and parameter tables
• Preparing example code blocks with correct language tagging
• Generating Markdown for static sites, wikis, or knowledge bases

Best practices

• Use H1 only for the document title and H2 for major sections
• Include a language identifier on all fenced code blocks
• Keep lines under 100 characters for readability
• Limit heading levels to three and nested lists to two levels
• Separate logical blocks with a blank line and prefer ATX-style headings

Example use cases

• Document a function: produce signature, parameters table, and return value section
• Turn meeting notes into a structured README with headings and action-item lists
• Convert tutorial content into step-by-step numbered procedures with code samples
• Create a comparison table for features or configuration options
• Format a changelog entry with version heading and bullet highlights