Home

Welcome to the nitpicky-md wiki!

A markdown parser that tells you when your markdown almost worked. CommonMark 0.31.2 + GFM compliant, zero runtime dependencies, and on top of the parse:

• near-miss diagnostics — *bold* with no closing *, a fence that never closes, #Heading missing its space — flagged with positions and, where the fix is mechanical, the edit itself
• parse provenance — explain() answers why is this text what it is, with the rule, the spec section, and the alternatives the parser rejected
• cross-dialect divergence — compare() finds where CommonMark and GFM (or any engine you inject) render the same document differently

Start here:

• Getting Started — install, first render, first diagnostics
• Diagnostics — the 10 rule codes, examples, and what was left out on purpose
• Explain — parse provenance and the decision trace
• Compare — cross-engine divergence checking, including CI usage
• CLI — every command, flag, and exit code

Spec status: 652/652 CommonMark 0.31.2 examples, 23/23 GFM extension examples plus 28 edge cases from the prose where the reference implementation disagrees with itself. Pathological inputs stay linear. The README has the full story.