heading-increment.md

heading-increment

Enforce heading levels increment by one.

Background

It can be difficult to keep track of the correct heading levels in a long document. Most of the time, you want to increment heading levels by one, so inside of a heading level 1 you'll have one or more heading level 2s. If you've skipped from, for example, heading level 1 to heading level 3, that is most likely an error.

Rule Details

This rule warns when it finds a heading that is more than on level higher than the preceding heading.

Examples of incorrect code:

# Hello world!

### Hello world!

Goodbye World!
--------------

#EEE Goodbye World!

When Not to Use It

If you aren't concerned with enforcing heading levels increment by one, you can safely disable this rule.

Prior Art

• MD001 - Header levels should only increment by one level at a time
• MD001 - heading-increment