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

This commit is contained in:
David Anson 2022-10-29 23:21:45 -07:00
parent 32c75ebfd9
commit 37baddcf27
110 changed files with 3875 additions and 179 deletions

37
doc/md001.md Normal file
View file

@ -0,0 +1,37 @@
# MD001 - Heading levels should only increment by one level at a time
Tags: headers, headings
Aliases: header-increment, heading-increment
This rule is triggered when you skip heading levels in a Markdown document, for
example:
```markdown
# 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:
```markdown
# 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/>.