Available Rules
The --fix option on the command line automatically fixes problems reported by rules which have a wrench 🔧 below.
The rules with the following star ⭐ are included in the plugin.configs.recommended config.
Preference Rules
| Rule ID | Description | Fixable | RECOMMENDED |
|---|---|---|---|
| markdown-preferences/canonical-code-block-language | enforce canonical language names in code blocks | 🔧 | |
| markdown-preferences/no-text-backslash-linebreak | disallow text backslash at the end of a line. | ⭐ | |
| markdown-preferences/prefer-inline-code-words | enforce the use of inline code for specific words. | 🔧 | |
| markdown-preferences/prefer-linked-words | enforce the specified word to be a link. | 🔧 |
Stylistic Rules
| Rule ID | Description | Fixable | RECOMMENDED |
|---|---|---|---|
| markdown-preferences/definitions-last | require link definitions and footnote definitions to be placed at the end of the document | 🔧 | |
| markdown-preferences/hard-linebreak-style | enforce consistent hard linebreak style. | 🔧 | ⭐ |
| markdown-preferences/heading-casing | enforce consistent casing in headings. | 🔧 | |
| markdown-preferences/no-laziness-blockquotes | disallow laziness in blockquotes | ⭐ | |
| markdown-preferences/no-multiple-empty-lines | disallow multiple empty lines in Markdown files. | 🔧 | |
| markdown-preferences/no-trailing-spaces | disallow trailing whitespace at the end of lines in Markdown files. | 🔧 | |
| markdown-preferences/prefer-autolinks | enforce the use of autolinks for URLs | 🔧 | ⭐ |
| markdown-preferences/prefer-fenced-code-blocks | enforce the use of fenced code blocks over indented code blocks | 🔧 | ⭐ |
| markdown-preferences/prefer-link-reference-definitions | enforce using link reference definitions instead of inline links | 🔧 | |
| markdown-preferences/sort-definitions | enforce a specific order for link definitions and footnote definitions | 🔧 |