2022-10-30 15:13:19 -07:00
|
|
|
# `MD001` - Heading levels should only increment by one level at a time
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Tags: `headers`, `headings`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Aliases: `header-increment`, `heading-increment`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
|
This rule is triggered when you skip heading levels in a Markdown document, for
|
|
|
|
|
example:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
# Heading 1
|
|
|
|
|
|
|
|
|
|
### Heading 3
|
|
|
|
|
|
|
|
|
|
We skipped out a 2nd level heading in this document
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
When using multiple heading levels, nested headings should increase by only one
|
|
|
|
|
level at a time:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
# Heading 1
|
|
|
|
|
|
|
|
|
|
## Heading 2
|
|
|
|
|
|
|
|
|
|
### Heading 3
|
|
|
|
|
|
|
|
|
|
#### Heading 4
|
|
|
|
|
|
|
|
|
|
## Another Heading 2
|
|
|
|
|
|
|
|
|
|
### Another Heading 3
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Rationale: Headings represent the structure of a document and can be confusing
|
|
|
|
|
when skipped - especially for accessibility scenarios. More information:
|
|
|
|
|
<https://www.w3.org/WAI/tutorials/page-structure/headings/>.
|
