Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 738 Bytes

md001.md

File metadata and controls

37 lines (23 loc) · 738 Bytes
Raw

MD001 - Heading levels should only increment by one level at a time

Tags: headings

Aliases: heading-increment

This rule is triggered when you skip heading levels in a Markdown document, for example:

# 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:

# 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/.