markdown/markdownlint

Checks every Markdown file against markdownlint with the shipped rule set.

Part of the markdown configuration, at the recommended level. It runs at the commit stage, per file. It runs markdownlint-cli2. gspot check --fix fixes what it can.

Why

Consistent Markdown renders the same in every viewer.

What to do

Run gspot check --fix for the rules that fix themselves; read the rule name for the rest.

Example

A heading that jumps from level one to level three reports MD001. Change the later heading to level two.

Turn it off

Turn it off for some files, or one of its lint rules, with a reason:

gspot ignore markdown/markdownlint --paths "<glob>" --reason "<why>"
gspot ignore markdown/markdownlint --rule <rule> --reason "<why>"

To silence one place, write a comment such as:

<!-- markdownlint-disable-next-line MD013 -- the table row cannot wrap -->