Markdownlint

Markdownlint config file

Type object
File match .markdownlintrc .markdownlint.json .markdownlint.jsonc .markdownlint.yaml .markdownlint.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/markdownlint/latest.json
Source https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

$schema string

JSON Schema URI (expected by some editors)

Default: "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.40.0/schema/markdownlint-config-schema.json"
default boolean | enum

Default state for all rules

Default: true
extends string | null

Path to configuration file to extend

Default: null
MD001 boolean | enum | object

MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md001.md

Default: true
heading-increment boolean | enum | object

MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md001.md

Default: true
MD003 boolean | enum | object

MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md003.md

Default: true
heading-style boolean | enum | object

MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md003.md

Default: true
MD004 boolean | enum | object

MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md004.md

Default: true
ul-style boolean | enum | object

MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md004.md

Default: true
MD005 boolean | enum | object

MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md005.md

Default: true
list-indent boolean | enum | object

MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md005.md

Default: true
MD007 boolean | enum | object

MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md007.md

Default: true
ul-indent boolean | enum | object

MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md007.md

Default: true
MD009 boolean | enum | object

MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md009.md

Default: true
no-trailing-spaces boolean | enum | object

MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md009.md

Default: true
MD010 boolean | enum | object

MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md010.md

Default: true
no-hard-tabs boolean | enum | object

MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md010.md

Default: true
MD011 boolean | enum | object

MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md011.md

Default: true
MD012 boolean | enum | object

MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md012.md

Default: true
no-multiple-blanks boolean | enum | object

MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md012.md

Default: true
MD013 boolean | enum | object

MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md013.md

Default: true
line-length boolean | enum | object

MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md013.md

Default: true
MD014 boolean | enum | object

MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md014.md

Default: true
commands-show-output boolean | enum | object

MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md014.md

Default: true
MD018 boolean | enum | object

MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md018.md

Default: true
no-missing-space-atx boolean | enum | object

MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md018.md

Default: true
MD019 boolean | enum | object

MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md019.md

Default: true
no-multiple-space-atx boolean | enum | object

MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md019.md

Default: true
MD020 boolean | enum | object

MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md020.md

Default: true
no-missing-space-closed-atx boolean | enum | object

MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md020.md

Default: true
MD021 boolean | enum | object

MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md021.md

Default: true
no-multiple-space-closed-atx boolean | enum | object

MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md021.md

Default: true
MD022 boolean | enum | object

MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md022.md

Default: true
blanks-around-headings boolean | enum | object

MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md022.md

Default: true
MD023 boolean | enum | object

MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md023.md

Default: true
heading-start-left boolean | enum | object

MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md023.md

Default: true
MD024 boolean | enum | object

MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md024.md

Default: true
no-duplicate-heading boolean | enum | object

MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md024.md

Default: true
MD025 boolean | enum | object

MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md025.md

Default: true
single-title boolean | enum | object

MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md025.md

Default: true
single-h1 boolean | enum | object

MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md025.md

Default: true
MD026 boolean | enum | object

MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md026.md

Default: true
no-trailing-punctuation boolean | enum | object

MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md026.md

Default: true
MD027 boolean | enum | object

MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md027.md

Default: true
no-multiple-space-blockquote boolean | enum | object

MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md027.md

Default: true
MD028 boolean | enum | object

MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md028.md

Default: true
no-blanks-blockquote boolean | enum | object

MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md028.md

Default: true
MD029 boolean | enum | object

MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md029.md

Default: true
ol-prefix boolean | enum | object

MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md029.md

Default: true
MD030 boolean | enum | object

MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md030.md

Default: true
list-marker-space boolean | enum | object

MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md030.md

Default: true
MD031 boolean | enum | object

MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md031.md

Default: true
blanks-around-fences boolean | enum | object

MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md031.md

Default: true
MD032 boolean | enum | object

MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md032.md

Default: true
blanks-around-lists boolean | enum | object

MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md032.md

Default: true
MD033 boolean | enum | object

MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md033.md

Default: true
no-inline-html boolean | enum | object

MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md033.md

Default: true
MD034 boolean | enum | object

MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md034.md

Default: true
no-bare-urls boolean | enum | object

MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md034.md

Default: true
MD035 boolean | enum | object

MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md035.md

Default: true
hr-style boolean | enum | object

MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md035.md

Default: true
MD036 boolean | enum | object

MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md036.md

Default: true
no-emphasis-as-heading boolean | enum | object

MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md036.md

Default: true
MD037 boolean | enum | object

MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md037.md

Default: true
no-space-in-emphasis boolean | enum | object

MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md037.md

Default: true
MD038 boolean | enum | object

MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md038.md

Default: true
no-space-in-code boolean | enum | object

MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md038.md

Default: true
MD039 boolean | enum | object

MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md039.md

Default: true
MD040 boolean | enum | object

MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md040.md

Default: true
fenced-code-language boolean | enum | object

MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md040.md

Default: true
MD041 boolean | enum | object

MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md041.md

Default: true
first-line-heading boolean | enum | object

MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md041.md

Default: true
first-line-h1 boolean | enum | object

MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md041.md

Default: true
MD042 boolean | enum | object

MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md042.md

Default: true
MD043 boolean | enum | object

MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md043.md

Default: true
required-headings boolean | enum | object

MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md043.md

Default: true
MD044 boolean | enum | object

MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md044.md

Default: true
proper-names boolean | enum | object

MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md044.md

Default: true
MD045 boolean | enum | object

MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md045.md

Default: true
no-alt-text boolean | enum | object

MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md045.md

Default: true
MD046 boolean | enum | object

MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md046.md

Default: true
code-block-style boolean | enum | object

MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md046.md

Default: true
MD047 boolean | enum | object

MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md047.md

Default: true
single-trailing-newline boolean | enum | object

MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md047.md

Default: true
MD048 boolean | enum | object

MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md048.md

Default: true
code-fence-style boolean | enum | object

MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md048.md

Default: true
MD049 boolean | enum | object

MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md049.md

Default: true
emphasis-style boolean | enum | object

MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md049.md

Default: true
MD050 boolean | enum | object

MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md050.md

Default: true
strong-style boolean | enum | object

MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md050.md

Default: true
MD051 boolean | enum | object

MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md051.md

Default: true
MD052 boolean | enum | object

MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md052.md

Default: true
MD053 boolean | enum | object

MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md053.md

Default: true
MD054 boolean | enum | object

MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md054.md

Default: true
MD055 boolean | enum | object

MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md055.md

Default: true
table-pipe-style boolean | enum | object

MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md055.md

Default: true
MD056 boolean | enum | object

MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md056.md

Default: true
table-column-count boolean | enum | object

MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md056.md

Default: true
MD058 boolean | enum | object

MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md058.md

Default: true
blanks-around-tables boolean | enum | object

MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md058.md

Default: true
MD059 boolean | enum | object

MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md059.md

Default: true
descriptive-link-text boolean | enum | object

MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md059.md

Default: true
MD060 boolean | enum | object

MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md060.md

Default: true
table-column-style boolean | enum | object

MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md060.md

Default: true
headings boolean | enum

headings : MD001, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043

Default: true
bullet boolean | enum

bullet : MD004, MD005, MD007, MD032

Default: true
ul boolean | enum

ul : MD004, MD005, MD007, MD030, MD032

Default: true
indentation boolean | enum

indentation : MD005, MD007, MD027

Default: true
whitespace boolean | enum

whitespace : MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039

Default: true
hard_tab boolean | enum

hard_tab : MD010

Default: true
blank_lines boolean | enum

blank_lines : MD012, MD022, MD031, MD032, MD047

Default: true
line_length boolean | enum

line_length : MD013

Default: true
code boolean | enum

code : MD014, MD031, MD038, MD040, MD046, MD048

Default: true
atx boolean | enum

atx : MD018, MD019

Default: true
spaces boolean | enum

spaces : MD018, MD019, MD020, MD021, MD023

Default: true
atx_closed boolean | enum

atx_closed : MD020, MD021

Default: true
blockquote boolean | enum

blockquote : MD027, MD028

Default: true
ol boolean | enum

ol : MD029, MD030, MD032

Default: true
html boolean | enum

html : MD033

Default: true
url boolean | enum

url : MD034

Default: true
hr boolean | enum

hr : MD035

Default: true
emphasis boolean | enum

emphasis : MD036, MD037, MD049, MD050

Default: true
language boolean | enum

language : MD040

Default: true
spelling boolean | enum

spelling : MD044

Default: true
accessibility boolean | enum

accessibility : MD045, MD059

Default: true
images boolean | enum

images : MD045, MD052, MD053, MD054

Default: true
table boolean | enum

table : MD055, MD056, MD058, MD060

Default: true