Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.39 KB

md026.md

File metadata and controls

40 lines (27 loc) · 1.39 KB
Raw

MD026 - Trailing punctuation in heading

Tags: headers, headings

Aliases: no-trailing-punctuation

Parameters:

  • punctuation: Punctuation characters (string, default .,;:!。，；：！)

Fixable: Some violations can be fixed by tooling

This rule is triggered on any heading that has one of the specified normal or full-width punctuation characters as the last character in the line:

# This is a heading.

To fix this, remove the trailing punctuation:

# This is a heading

Note: The punctuation parameter can be used to specify what characters count as punctuation at the end of a heading. For example, you can change it to ".,;:" to allow headings that end with an exclamation point. ? is allowed by default because of how common it is in headings of FAQ-style documents. Setting the punctuation parameter to "" allows all characters - and is equivalent to disabling the rule.

Note: The trailing semicolon of HTML entity references like ©, ©, and © is ignored by this rule.

Rationale: Headings are not meant to be full sentences. More information: Punctuation at the end of headers.