Skip to content

Instantly share code, notes, and snippets.

@stedman
Created November 28, 2020 23:28
Show Gist options
  • Save stedman/60f962085afe8655423a10297ab8924b to your computer and use it in GitHub Desktop.
Save stedman/60f962085afe8655423a10297ab8924b to your computer and use it in GitHub Desktop.
MarkdownLint default config file
{
"default": true, // Default state for all rules
"MD001": true, // heading-increment/header-increment - Heading levels should only increment by one level at a time
"MD002": {
"level": 1
}, // first-heading-h1/first-header-h1 - DEPRECATED - First heading should be a top level heading
"MD003": {
"style": "consistent"
}, // heading-style/header-style - Heading style
"MD004": {
"style": "consistent"
}, // ul-style - Unordered list style
"MD005": true, // list-indent - Inconsistent indentation for list items at the same level
"MD006": true, // ul-start-left - DEPRECATED - Consider starting bulleted lists at the beginning of the line
"MD007": {
"indent": 2
}, // ul-indent - Unordered list indentation
"MD009": {
"br_spaces": 2,
"list_item_empty_lines": false,
"strict": false
}, // no-trailing-spaces - Trailing spaces
"MD010": {
"code_blocks": true
}, // no-hard-tabs - Hard tabs
"MD011": true, // no-reversed-links - Reversed link syntax
"MD012": {
"maximum": 1
}, // no-multiple-blanks - Multiple consecutive blank lines
"MD013": {
"line_length": 80,
"heading_line_length": 80,
"code_block_line_length": 80,
"code_blocks": true,
"tables": true,
"headings": true,
"headers": true,
"strict": false,
"stern": false
}, // line-length - Line length
"MD014": true, // commands-show-output - Dollar signs used before commands without showing output
"MD018": true, // no-missing-space-atx - No space after hash on atx style heading
"MD019": true, // no-multiple-space-atx - Multiple spaces after hash on atx style heading
"MD020": true, // no-missing-space-closed-atx - No space inside hashes on closed atx style heading
"MD021": true, // no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading
"MD022": {
"lines_above": 1,
"lines_below": 1
}, // blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
"MD023": true, // heading-start-left/header-start-left - Headings must start at the beginning of the line
"MD024": {
"allow_different_nesting": false,
"siblings_only": false
}, // no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
"MD025": {
"level": 1,
"front_matter_title": "^\\s*title\\s*[:=]"
}, // single-title/single-h1 - Multiple top level headings in the same document
"MD026": {
"punctuation": ".,;:!。,;:!"
}, // no-trailing-punctuation - Trailing punctuation in heading
"MD027": true, // no-multiple-space-blockquote - Multiple spaces after blockquote symbol
"MD028": true, // no-blanks-blockquote - Blank line inside blockquote
"MD029": {
"style": "one_or_ordered"
}, // ol-prefix - Ordered list item prefix (alt: "one", "ordered", "zero")
"MD030": {
"ul_single": 1,
"ol_single": 1,
"ul_multi": 1,
"ol_multi": 1
}, // list-marker-space - Spaces after list markers
"MD031": {
"list_items": true
}, // blanks-around-fences - Fenced code blocks should be surrounded by blank lines
"MD032": true, // blanks-around-lists - Lists should be surrounded by blank lines
"MD033": {
"allowed_elements": []
}, // no-inline-html - Inline HTML
"MD034": true, // no-bare-urls - Bare URL used
"MD035": {
"style": "consistent"
}, // hr-style - Horizontal rule style (alt: "---", "***")
"MD036": {
"punctuation": ".,;:!?。,;:!?"
}, // no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading (alt: )
"MD037": true, // no-space-in-emphasis - Spaces inside emphasis markers
"MD038": true, // no-space-in-code - Spaces inside code span elements
"MD039": true, // no-space-in-links - Spaces inside link text
"MD040": true, // fenced-code-language - Fenced code blocks should have a language specified
"MD041": {
"level": 1,
"front_matter_title": "^\\s*title\\s*[:=]"
}, // first-line-heading/first-line-h1 - First line in file should be a top level heading
"MD042": true, // no-empty-links - No empty links
"MD043": {
"headings": null,
"headers": null
}, // required-headings/required-headers - Required heading structure
"MD044": {
"names": null,
"code_blocks": true
}, // proper-names - Proper names should have the correct capitalization
"MD045": true, // no-alt-text - Images should have alternate text (alt text)
"MD046": {
"style": "consistent"
}, // code-block-style - Code block style (alt: "fenced", "indented")
"MD047": true, // single-trailing-newline - Files should end with a single newline character
"MD048": {
"style": "consistent"
} // code-fence-style - Code fence style (alt: "backtick", "tilde")
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment