mdv explain

Show what a rule, diagnostic code, field kind, or document's contract means.

Fascinating. Ask any rule why it fired and it will tell you, at length, without a hint of emotion.

Usage

mdv explain <rule|code|field-kind|path>

Arguments

  • <rule|code|field-kind|path> — A rule name (content.words.min), a diagnostic code (missing-section), a field kind (list), or a Markdown document path.

Examples

mdv explain content.words.min   # show what a rule or field kind means
mdv explain missing-section     # show what a finding means, how to fix it, and how to downgrade or turn it off
mdv explain README.md           # show the governing contract and rules per heading

On this page