markdownlint/doc-build/md001.md at main

mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00

David Anson 37baddcf27 Generate Rules.md and md###.md files from metadata, improve Parameters documentation by referencing schema.

2022-10-29 23:21:45 -07:00

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