markdown-linting

Topics in the source

• Markdown Linting
• Table of contents
• Overview
• Usage
• Check all markdown files
• Automatically fix what can be fixed
• Configuration
• Responsibilities

Overview Usage Configuration Responsibilities Common errors and solutions MD029: List numbering MD040: Missing code block language MD051: Broken anchor link Common AI mistake: Closing a code block with a language -- This workspace uses markdownlint-cli2 via npx to catch markdown errors before they are committed. Focus areas: 1. List numbering (MD029) - Numbered lists must restart at 1 after headers 2. Anchor links (MD051) - TOC links must match actual heading anchors 3. Code block language (MD040) - All code blocks must specify language (tsx, typescript, bash, etc.) See .markdownlint-cli2.jsonc for the rules. Run linting on markdown files after writing, editing or moving them Fix all MD029, MD040 and MD051 errors before the task is done Command: npx markdownlint-cli2 or npx markdownlint-cli2 '/.md' Wrong: Solution: Wrong: Solution: Important: Use tsx for React/JSX code, not typescript. Wrong: Solution: Or update the HTML anchor: to: Wrong (not caught by the linter, but breaks HTML generation): Why this happens: AI assistants (Claude, Copilot, etc.) sometimes write text as a closing fence This is NOT valid markdown - code blocks are ALWAYS closed with just Pandoc and other converter

This is an excerpt. Refer to the complete source and its current requirements.