mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
80 lines
1.8 KiB
Markdown
80 lines
1.8 KiB
Markdown
|
# MD030 - Spaces after list markers
|
||
|
|
|
||
|
|
Tags: ol, ul, whitespace
|
||
|
|
|
||
|
|
Aliases: list-marker-space
|
||
|
|
|
||
|
|
Parameters:
|
||
|
|
|
||
|
|
* `ol_multi`: Spaces for multi-line ordered list items (`integer`, default `1`)
|
||
|
|
* `ol_single`: Spaces for single-line ordered list items (`integer`, default `1`)
|
||
|
|
* `ul_multi`: Spaces for multi-line unordered list items (`integer`, default `1`)
|
||
|
|
* `ul_single`: Spaces for single-line unordered list items (`integer`, default `1`)
|
||
|
|
|
||
|
|
Fixable: Most violations can be fixed by tooling
|
||
|
|
|
||
|
|
This rule checks for the number of spaces between a list marker (e.g. '`-`',
|
||
|
|
'`*`', '`+`' or '`1.`') and the text of the list item.
|
||
|
|
|
||
|
|
The number of spaces checked for depends on the document style in use, but the
|
||
|
|
default is 1 space after any list marker:
|
||
|
|
|
||
|
|
```markdown
|
||
|
|
* Foo
|
||
|
|
* Bar
|
||
|
|
* Baz
|
||
|
|
|
||
|
|
1. Foo
|
||
|
|
1. Bar
|
||
|
|
1. Baz
|
||
|
|
|
||
|
|
1. Foo
|
||
|
|
* Bar
|
||
|
|
1. Baz
|
||
|
|
```
|
||
|
|
|
||
|
|
A document style may change the number of spaces after unordered list items
|
||
|
|
and ordered list items independently, as well as based on whether the content
|
||
|
|
of every item in the list consists of a single paragraph or multiple
|
||
|
|
paragraphs (including sub-lists and code blocks).
|
||
|
|
|
||
|
|
For example, the style guide at
|
||
|
|
<https://cirosantilli.com/markdown-style-guide#spaces-after-list-marker>
|
||
|
|
specifies that 1 space after the list marker should be used if every item in
|
||
|
|
the list fits within a single paragraph, but to use 2 or 3 spaces (for ordered
|
||
|
|
and unordered lists respectively) if there are multiple paragraphs of content
|
||
|
|
inside the list:
|
||
|
|
|
||
|
|
```markdown
|
||
|
|
* Foo
|
||
|
|
* Bar
|
||
|
|
* Baz
|
||
|
|
```
|
||
|
|
|
||
|
|
vs.
|
||
|
|
|
||
|
|
```markdown
|
||
|
|
* Foo
|
||
|
|
|
||
|
|
Second paragraph
|
||
|
|
|
||
|
|
* Bar
|
||
|
|
```
|
||
|
|
|
||
|
|
or
|
||
|
|
|
||
|
|
```markdown
|
||
|
|
1. Foo
|
||
|
|
|
||
|
|
Second paragraph
|
||
|
|
|
||
|
|
1. Bar
|
||
|
|
```
|
||
|
|
|
||
|
|
To fix this, ensure the correct number of spaces are used after the list marker
|
||
|
|
for your selected document style.
|
||
|
|
|
||
|
|
Rationale: Violations of this rule can lead to improperly rendered content.
|
||
|
|
|
||
|
|
Note: See [Prettier.md](Prettier.md) for compatibility information.
|