Multiple spaces after hash on atx style header Open
#### This project exists thanks to all the people who contribute
- Read upRead up
- Exclude checks
MD019 - Multiple spaces after hash on atx style header
Tags: headers, atx, spaces
Aliases: no-multiple-space-atx
This rule is triggered when more than one space is used to separate the header text from the hash characters in an atx style header:
# Header 1
## Header 2
To fix this, separate the header text from the hash character by a single space:
# Header 1
## Header 2
Headers should be surrounded by blank lines Open
#### This project exists thanks to all the people who contribute
- Read upRead up
- Exclude checks
MD022 - Headers should be surrounded by blank lines
Tags: headers, blank_lines
Aliases: blanks-around-headers
This rule is triggered when headers (any style) are either not preceded or not followed by a blank line:
# Header 1
Some text
Some more text
## Header 2
To fix this, ensure that all headers have a blank line both before and after (except where the header is at the beginning or end of the document):
# Header 1
Some text
Some more text
## Header 2
Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headers that don't have a blank line before, and will parse them as regular text.
Header levels should only increment by one level at a time Open
#### This project exists thanks to all the people who contribute
- Read upRead up
- Exclude checks
MD001 - Header levels should only increment by one level at a time
Tags: headers
Aliases: header-increment
This rule is triggered when you skip header levels in a markdown document, for example:
# Header 1
### Header 3
We skipped out a 2nd level header in this document
When using multiple header levels, nested headers should increase by only one level at a time:
# Header 1
## Header 2
### Header 3
#### Header 4
## Another Header 2
### Another Header 3