mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-21 21:30:47 +02: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
38
doc/md032.md
Normal file
38
doc/md032.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
# MD032 - Lists should be surrounded by blank lines
|
||||
|
||||
Tags: blank_lines, bullet, ol, ul
|
||||
|
||||
Aliases: blanks-around-lists
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered when lists (of any kind) are either not preceded or not
|
||||
followed by a blank line:
|
||||
|
||||
```markdown
|
||||
Some text
|
||||
* Some
|
||||
* List
|
||||
|
||||
1. Some
|
||||
2. List
|
||||
Some text
|
||||
```
|
||||
|
||||
To fix this, ensure that all lists have a blank line both before and after
|
||||
(except where the block is at the beginning or end of the document):
|
||||
|
||||
```markdown
|
||||
Some text
|
||||
|
||||
* Some
|
||||
* List
|
||||
|
||||
1. Some
|
||||
2. List
|
||||
|
||||
Some text
|
||||
```
|
||||
|
||||
Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will
|
||||
not parse lists that don't have blank lines before and after them.
|
Loading…
Add table
Add a link
Reference in a new issue