Markdown Formatter
Format, lint, and restructure markdown documents for consistent style and readability
Details
Categoryfile
Content Preview
--- name: Markdown Formatter description: Format, lint, and restructure markdown documents for consistent style and readability version: 1.0.0 author: chvor type: workflow category: file icon: file-text tags: - markdown - formatting - documentation - linting - headings - tables - style - readme - docs --- When the user asks you to format, clean up, or restructure a markdown document: ## Process 1. **Read the full document** before making changes 2. **Fix structural issues first**, then formatting details ## Checks to apply ### Structure - **Heading hierarchy**: H1 → H2 → H3 — no skipping levels (e.g., H1 → H3) - **Single H1**: Only one `#` heading per document (the title) - **Logical flow**: Sections should follow a natural order (intro → details → conclusion) ### Formatting - **Consistent list style**: All bullets use `-` (not mixed `-`, `*`, `+`) - **Consistent emphasis**: Bold for key terms, italic for titles/emphasis — not random - **Code blocks**: Specify language for syntax highlighting (```js not ```) - **Tables**: Aligned columns, consistent header separators - **Links**: No broken links (flag if you can't verify), descriptive link text (not "click here") - **Line length**: Wrap prose at ~80–120 chars for readability in plain text editors (optional) - **Trailing whitespace**: Remove it - **Blank lines**: One blank line between sections, not two or three ### Content - **Table of contents**: Add one for documents with 4+ sections - **Front matter