markdownlint
Version:
A Node.js style checker and lint tool for Markdown/CommonMark files.
38 lines (23 loc) • 738 B
Markdown
Tags: `headings`
Aliases: `heading-increment`
This rule is triggered when you skip heading levels in a Markdown document, for
example:
```markdown
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
```
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/>.