Skip to content

Rules#

Rule - MD001#

Full Documentation

Property Value
Aliases md001, heading-increment, header-increment
Autofix Available Yes
Enabled By Default Yes

Summary#

Heading levels should only increment by one level at a time.

Rule - MD002#

Full Documentation

Property Value
Aliases md002, first-heading-h1, first-header-h1
Autofix Available No
Enabled By Default No

Deprecation#

This rule has been deprecated in favor of Rule Md041.

Summary#

First heading of the document should be a top-level heading.

Rule - MD003#

Full Documentation

Property Value
Aliases md003, heading-style, header-style
Autofix Available Pending
Enabled By Default Yes

Summary#

Heading style should be consistent throughout the document.

Rule - MD004#

Full Documentation

Property Value
Aliases md004, ul-style
Autofix Available Yes
Enabled By Default Yes

Summary#

Inconsistent Unordered List Start style.

Rule - MD005#

Full Documentation

Property Value
Aliases md005, list-indent
Autofix Available Yes
Enabled By Default Yes

Summary#

Inconsistent indentation for list items at the same level.

Rule - MD006#

Full Documentation

Property Value
Aliases md006, ul-start-left
Autofix Available Yes
Enabled By Default No

Deprecation#

This rule has been deprecated in favor of Rule Md007.

Summary#

Consider starting bulleted lists at the beginning of the line.

Rule - MD007#

Full Documentation

Property Value
Aliases md007, ul-indent
Autofix Available Yes
Enabled By Default Yes

Summary#

Unordered list indentation.

Rule - MD009#

Full Documentation

Property Value
Aliases md009, no-trailing-spaces
Autofix Available Yes
Enabled By Default Yes

Summary#

Trailing spaces.

Rule - MD010#

Full Documentation

Property Value
Aliases md010, no-hard-tabs
Autofix Available Yes
Enabled By Default Yes

Summary#

Hard tabs.

Rule - MD011#

Full Documentation

Property Value
Aliases md011, no-reversed-links
Autofix Available Pending
Enabled By Default Yes

Summary#

Reversed link syntax.

Rule - MD012#

Full Documentation

Property Value
Aliases md012, no-multiple-blanks
Autofix Available Pending
Enabled By Default Yes

Summary#

Multiple consecutive blank lines.

Rule - MD013#

Full Documentation

Property Value
Aliases md013, line-length
Autofix Available Yes
Enabled By Default Yes

Summary#

Line length.

Rule - MD014#

Full Documentation

Property Value
Aliases md014, commands-show-output
Autofix Available No
Enabled By Default Yes

Summary#

Dollar signs used before commands without showing output.

Rule - MD018#

Full Documentation

Property Value
Aliases md018, no-missing-space-atx
Autofix Available No
Enabled By Default Yes

Summary#

No space present after the hash character on a possible Atx Heading.

Rule - MD019#

Full Documentation

Property Value
Aliases md019, no-multiple-space-atx
Autofix Available Yes
Enabled By Default Yes

Summary#

Multiple spaces are present after hash character on Atx Heading.

Rule - MD020#

Full Documentation

Property Value
Aliases md020, no-missing-space-closed-atx
Autofix Available No
Enabled By Default Yes

Summary#

No space present inside of the hashes on a possible Atx Closed Heading.

Rule - MD021#

Full Documentation

Property Value
Aliases md021, no-multiple-space-closed-atx
Autofix Available Yes
Enabled By Default Yes

Summary#

Multiple spaces are present inside hash characters on Atx Closed Heading.

Rule - MD022#

Full Documentation

Property Value
Aliases md022, blanks-around-headings, blanks-around-headers
Autofix Available Pending
Enabled By Default Yes

Summary#

Headings should be surrounded by blank lines.

Rule - MD023#

Full Documentation

Property Value
Aliases md023, heading-start-left, header-start-left
Autofix Available Yes
Enabled By Default Yes

Summary#

Headings must start at the beginning of the line.

Rule - MD024#

Full Documentation

Property Value
Aliases md024, no-duplicate-heading, no-duplicate-header
Autofix Available No
Enabled By Default Yes

Summary#

Multiple headings cannot contain the same content.

Rule - MD025#

Full Documentation

Property Value
Aliases md025, single-title, single-h1
Autofix Available No
Enabled By Default Yes

Summary#

Multiple top-level headings in the same document.

Rule - MD026#

Full Documentation

Property Value
Aliases md026, no-trailing-punctuation
Autofix Available No
Enabled By Default Yes

Summary#

Trailing punctuation present in heading text.

Rule - MD027#

Full Documentation

Property Value
Aliases md027, no-multiple-space-blockquote
Autofix Available Yes
Enabled By Default Yes

Summary#

Multiple spaces after blockquote symbol.

Rule - MD028#

Full Documentation

Property Value
Aliases md028, no-blanks-blockquote
Autofix Available No
Enabled By Default Yes

Summary#

Blank line inside blockquote.

Rule - MD029#

Full Documentation

Property Value
Aliases md029, ol-prefix
Autofix Available Yes
Enabled By Default Yes

Summary#

Ordered list item prefix.

Rule - MD030#

Full Documentation

Property Value
Aliases md030, list-marker-space
Autofix Available Yes
Enabled By Default Yes

Summary#

Spaces after list markers.

Rule - MD031#

Full Documentation

Property Value
Aliases md031, blanks-around-fences
Autofix Available Pending
Enabled By Default Yes

Summary#

Fenced code blocks should be surrounded by blank lines.

Rule - MD032#

Full Documentation

Property Value
Aliases md032, blanks-around-lists
Autofix Available Pending
Enabled By Default Yes

Summary#

List blocks should be surrounded by blank lines.

Rule - MD033#

Full Documentation

Property Value
Aliases md033, no-inline-html
Autofix Available No*
Enabled By Default Yes

Summary#

Inline HTML.

Rule - MD034#

Full Documentation

Property Value
Aliases md034, no-bare-urls
Autofix Available No*
Enabled By Default Yes

Summary#

Bare URL used.

Rule - MD035#

Full Documentation

Property Value
Aliases md035, hr-style
Autofix Available Yes
Enabled By Default Yes

Summary#

Horizontal rule style.

Rule - MD036#

Full Documentation

Property Value
Aliases md036, no-emphasis-as-heading, no-emphasis-as-header
Autofix Available No
Enabled By Default Yes

Summary#

Emphasis possibly used instead of a heading element.

Rule - MD037#

Full Documentation

Property Value
Aliases md037, no-space-in-emphasis
Autofix Available Yes
Enabled By Default Yes

Summary#

Spaces inside emphasis markers.

Rule - MD038#

Full Documentation

Property Value
Aliases md038, no-space-in-code
Autofix Available Yes*
Enabled By Default Yes

Summary#

Spaces inside code span elements.

Rule - MD039#

Full Documentation

Property Value
Aliases md039, no-space-in-links
Autofix Available Yes
Enabled By Default Yes

Summary#

Spaces inside link text.

Rule - MD040#

Full Documentation

Property Value
Aliases md040, fenced-code-language
Autofix Available No
Enabled By Default Yes

Summary#

Fenced code blocks should have a language specified.

Rule - MD041#

Full Documentation

Property Value
Aliases md041, first-line-heading, first-line-h1
Autofix Available No
Enabled By Default Yes

Summary#

First line in file should be a top-level heading.

Rule - MD042#

Full Documentation

Property Value
Aliases md042, no-empty-links
Autofix Available No
Enabled By Default Yes

Summary#

No empty links.

Rule - MD043#

Full Documentation

Property Value
Aliases md043, required-headings, required-headers
Autofix Available No
Enabled By Default Yes

Summary#

Required heading structure.

Rule - MD044#

Full Documentation

Property Value
Aliases md044, proper-names
Autofix Available Yes
Enabled By Default Yes

Summary#

Proper names should have the correct capitalization.

Rule - MD045#

Full Documentation

Property Value
Aliases md045, no-alt-text
Autofix Available No
Enabled By Default Yes

Summary#

Images should have alternate text (alt text).

Rule - MD046#

Full Documentation

Property Value
Aliases md046, code-block-style
Autofix Available Yes
Enabled By Default Yes

Summary#

Code block style.

Rule - MD047#

Full Documentation

Property Value
Aliases md047, single-trailing-newline
Autofix Available Yes
Enabled By Default Yes

Summary#

Each file should end with a single newline character.

Rule - MD048#

Full Documentation

Property Value
Aliases md048, code-fence-style
Autofix Available Yes
Enabled By Default Yes

Summary#

Code fence style should be consistent throughout the document.

Rule - PML100#

Full Documentation

Property Value
Aliases pml100, disallowed-html
Autofix Available Pending review
Enabled By Default No

Summary#

Disallowed HTML elements.

Rule - PML101#

Full Documentation

Property Value
Aliases pml101, list-anchored-indent
Autofix Available Pending review
Enabled By Default No

Summary#

Anchored list indentation.

Rule - PML102#

Full Documentation

Property Value
Aliases pml102, disallow-lazy-list-indentation
Autofix Available In Queue
Enabled By Default No

Summary#

Disallow "lazy" paragraph continuations within lists.

Enable This Rule If#

This rule is disabled by default. Enable this rule if you want to generate Rule Failures when the Markdown documents contain multiple line paragraphs where the indentation for each paragraph line does not match the indentation for the list that contains it.