headingIncrements
Reports heading levels incrementing by more than one.
✅ This rule is included in the md logical
preset.
Heading levels describe the organization and structure of a Markdown document. When increasing the level of a heading from its parent, the level should only ever increment by one. Skipping heading ranks can be confusing -especially for automated tools and screen-readers- and should be avoided where possible.
Examples
Section titled “Examples”# A
### B
# A
## B
Options
Section titled “Options”This rule is not configurable.
Further Reading
Section titled “Further Reading”Equivalents in Other Linters
Section titled “Equivalents in Other Linters”- ESLint:
markdown/heading-increment
Made with ❤️🔥 in Boston by
Josh Goldberg and contributors.