mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2026-02-16 10:18:06 +01:00
29 lines
506 B
Markdown
29 lines
506 B
Markdown
|
# 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
|