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

53
doc/md005.md Normal file
View file

@ -0,0 +1,53 @@
# MD005 - Inconsistent indentation for list items at the same level
Tags: bullet, indentation, ul
Aliases: list-indent
Fixable: Most violations can be fixed by tooling
This rule is triggered when list items are parsed as being at the same level,
but don't have the same indentation:
```markdown
* Item 1
* Nested Item 1
* Nested Item 2
* A misaligned item
```
Usually, this rule will be triggered because of a typo. Correct the indentation
for the list to fix it:
```markdown
* Item 1
* Nested Item 1
* Nested Item 2
* Nested Item 3
```
Sequentially-ordered list markers are usually left-aligned such that all items
have the same starting column:
```markdown
...
8. Item
9. Item
10. Item
11. Item
...
```
This rule also supports right-alignment of list markers such that all items have
the same ending column:
```markdown
...
8. Item
9. Item
10. Item
11. Item
...
```
Rationale: Violations of this rule can lead to improperly rendered content.