mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2026-02-27 23:34:07 +01:00
Generate Rules.md and md###.md files from metadata, improve Parameters documentation by referencing schema.
This commit is contained in:
parent
32c75ebfd9
commit
37baddcf27
110 changed files with 3875 additions and 179 deletions
46
doc/md006.md
Normal file
46
doc/md006.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# ~~MD006 - Consider starting bulleted lists at the beginning of the line~~
|
||||
|
||||
> This rule is deprecated and provided for backward-compatibility
|
||||
|
||||
Tags: bullet, indentation, ul
|
||||
|
||||
Aliases: ul-start-left
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when top-level lists don't start at the beginning of a
|
||||
line:
|
||||
|
||||
```markdown
|
||||
Some text
|
||||
|
||||
* List item
|
||||
* List item
|
||||
```
|
||||
|
||||
To fix, ensure that top-level list items are not indented:
|
||||
|
||||
```markdown
|
||||
Some test
|
||||
|
||||
* List item
|
||||
* List item
|
||||
```
|
||||
|
||||
Note: This rule is triggered for the following scenario because the unordered
|
||||
sublist is not recognized as such by the parser. Not being nested 3 characters
|
||||
as required by the outer ordered list, it creates a top-level unordered list
|
||||
instead.
|
||||
|
||||
```markdown
|
||||
1. List item
|
||||
- List item
|
||||
- List item
|
||||
1. List item
|
||||
```
|
||||
|
||||
Rationale: Starting lists at the beginning of the line means that nested list
|
||||
items can all be indented by the same amount when an editor's indent function
|
||||
or the tab key is used to indent. Starting a list 1 space in means that the
|
||||
indent of the first nested list is less than the indent of the second level (3
|
||||
characters if you use 4 space tabs, or 1 character if you use 2 space tabs).
|
||||
Loading…
Add table
Add a link
Reference in a new issue