This file serves as a comprehensive reference to all markdownlint rules and their configurable options with defaults set. It can be used directly as .markdownlint.json
or .markdownlint.jsonc
and adjusted as needed.
Struck through rules are deprecated, and provided for backward-compatibility.
All rules with
heading
as part of their name are also available asheader
aliases (e.g.heading-increment
is also available asheader-increment
). The use ofheader
is deprecated and provided for backward-compatibility.
* [MD001](doc/Rules.md#md001) *heading-increment/header-increment* - Heading levels should only increment by one level at a time
* ~~**[MD002](doc/Rules.md#md002)** *first-heading-h1/first-header-h1* - First heading should be a top-level heading~~
* [MD003](doc/Rules.md#md003) *heading-style/header-style* - Heading style
* [MD004](doc/Rules.md#md004) *ul-style* - Unordered list style
* [MD005](doc/Rules.md#md005) *list-indent* - Inconsistent indentation for list items at the same level
* ~~**[MD006](doc/Rules.md#md006)** *ul-start-left* - Consider starting bulleted lists at the beginning of the line~~
* [MD007](doc/Rules.md#md007) *ul-indent* - Unordered list indentation
* [MD009](doc/Rules.md#md009) *no-trailing-spaces* - Trailing spaces
* [MD010](doc/Rules.md#md010) *no-hard-tabs* - Hard tabs
* [MD011](doc/Rules.md#md011) *no-reversed-links* - Reversed link syntax
* [MD012](doc/Rules.md#md012) *no-multiple-blanks* - Multiple consecutive blank lines
* [MD013](doc/Rules.md#md013) *line-length* - Line length
* [MD014](doc/Rules.md#md014) *commands-show-output* - Dollar signs used before commands without showing output
* [MD018](doc/Rules.md#md018) *no-missing-space-atx* - No space after hash on atx style heading
* [MD019](doc/Rules.md#md019) *no-multiple-space-atx* - Multiple spaces after hash on atx style heading
* [MD020](doc/Rules.md#md020) *no-missing-space-closed-atx* - No space inside hashes on closed atx style heading
* [MD021](doc/Rules.md#md021) *no-multiple-space-closed-atx* - Multiple spaces inside hashes on closed atx style heading
* [MD022](doc/Rules.md#md022) *blanks-around-headings/blanks-around-headers* - Headings should be surrounded by blank lines
* [MD023](doc/Rules.md#md023) *heading-start-left/header-start-left* - Headings must start at the beginning of the line
* [MD024](doc/Rules.md#md024) *no-duplicate-heading/no-duplicate-header* - Multiple headings with the same content
* [MD025](doc/Rules.md#md025) *single-title/single-h1* - Multiple top-level headings in the same document
* [MD026](doc/Rules.md#md026) *no-trailing-punctuation* - Trailing punctuation in heading
* [MD027](doc/Rules.md#md027) *no-multiple-space-blockquote* - Multiple spaces after blockquote symbol
* [MD028](doc/Rules.md#md028) *no-blanks-blockquote* - Blank line inside blockquote
* [MD029](doc/Rules.md#md029) *ol-prefix* - Ordered list item prefix
* [MD030](doc/Rules.md#md030) *list-marker-space* - Spaces after list markers
* [MD031](doc/Rules.md#md031) *blanks-around-fences* - Fenced code blocks should be surrounded by blank lines
* [MD032](doc/Rules.md#md032) *blanks-around-lists* - Lists should be surrounded by blank lines
* [MD033](doc/Rules.md#md033) *no-inline-html* - Inline HTML
* [MD034](doc/Rules.md#md034) *no-bare-urls* - Bare URL used
* [MD035](doc/Rules.md#md035) *hr-style* - Horizontal rule style
* [MD036](doc/Rules.md#md036) *no-emphasis-as-heading/no-emphasis-as-header* - Emphasis used instead of a heading
* [MD037](doc/Rules.md#md037) *no-space-in-emphasis* - Spaces inside emphasis markers
* [MD038](doc/Rules.md#md038) *no-space-in-code* - Spaces inside code span elements
* [MD039](doc/Rules.md#md039) *no-space-in-links* - Spaces inside link text
* [MD040](doc/Rules.md#md040) *fenced-code-language* - Fenced code blocks should have a language specified
* [MD041](doc/Rules.md#md041) *first-line-heading/first-line-h1* - First line in a file should be a top-level heading
* [MD042](doc/Rules.md#md042) *no-empty-links* - No empty links
* [MD043](doc/Rules.md#md043) *required-headings/required-headers* - Required heading structure
* [MD044](doc/Rules.md#md044) *proper-names* - Proper names should have the correct capitalization
* [MD045](doc/Rules.md#md045) *no-alt-text* - Images should have alternate text (alt text)
* [MD046](doc/Rules.md#md046) *code-block-style* - Code block style
* [MD047](doc/Rules.md#md047) *single-trailing-newline* - Files should end with a single newline character
* [MD048](doc/Rules.md#md048) *code-fence-style* - Code fence style
Tags group related rules and can be used to enable/disable multiple rules at once.
- accessibility - MD045
- atx - MD018, MD019
- atx_closed - MD020, MD021
- blank_lines - MD012, MD022, MD031, MD032, MD047
- blockquote - MD027, MD028
- bullet - MD004, MD005, MD006, MD007, MD032
- code - MD014, MD031, MD038, MD040, MD046, MD048
- emphasis - MD036, MD037
- hard_tab - MD010
- headers - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043
- headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043
- hr - MD035
- html - MD033
- images - MD045
- indentation - MD005, MD006, MD007, MD027
- language - MD040
- line_length - MD013
- links - MD011, MD034, MD039, MD042
- ol - MD029, MD030, MD032
- spaces - MD018, MD019, MD020, MD021, MD023
- spelling - MD044
- ul - MD004, MD005, MD006, MD007, MD030, MD032
- url - MD034
- whitespace - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039
If more context or usage examples are needed for specific rules, official documentation links are available for each rule in the markdownlint repo.1
- https://app.unpkg.com/[email protected]/files/README.md
- https://github.com/DavidAnson/markdownlint
- https://www.npmjs.com/package/markdownlint
- https://github.com/DavidAnson/markdownlint-cli2
- https://megalinter.io/latest/descriptors/markdown_markdownlint/
- https://classic.yarnpkg.com/en/package/markdownlint-rule-helpers
- https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
- https://megalinter.io/v5.0.3/descriptors/markdown_markdownlint/
- https://stackoverflow.com/questions/74319856/how-to-handle-wide-markdown-tables-and-line-length-checks-in-pre-commit
- https://stackoverflow.com/questions/49056000/all-of-my-json-files-have-problems-loading-reference-schema-from-schemastore-az