Rule - MD030#
| Property | Value |
|---|---|
| Aliases | md030, list-marker-space |
| Autofix Available | Yes |
| Enabled By Default | Yes |
Summary#
Spaces after list markers.
Reasoning#
Consistency#
Some older parsers do not manage varying number of spaces after the list markers well.
Examples#
Failure Scenarios#
This rule triggers when a List Item element is not followed by 1 space character before the text starts:
Markdown
1. first item
Markdown
+ first item
Correct Scenarios#
This rule does not trigger if all List Item elements are followed by 1 space before any text starts:
Markdown
1. first item
Markdown
+ first item
The ol_single and ol_multi configuration values specify the number of space
characters before text for Ordered List elements, and the ul_single and ul_multi
configuration values specify the number of space characters before text for
Unordered List elements.
For this rule, a single List Item is one that does not contain two or
more paragraphs and a double List Item is one that does contain two or more paragraphs.
Therefore, setting ul_single to 2 and ul_multi to 1 will cause this list not
to trigger this rule:
```Markdown + first item + second item + inner item
inner item
```
Fix Description#
When fixed, the number of spaces between a list start and the following text are set to the configured amount of spacing. By default, this means ordered and unordered list start sequences will be set to have 1 space before the text.
Configuration#
| Prefixes |
|---|
plugins.md030. |
plugins.list-marker-space. |
| Value Name | Type | Default | Description |
|---|---|---|---|
enabled |
boolean |
True |
Whether the Rule Plugin is enabled. |
ul_single |
integer | 1 |
Spaces after an Unordered List Item and any following text for a single line item. |
ol_single |
integer | 1 |
Spaces after an Ordered List Item and any following text for a single line item. |
ul_multi |
integer | 1 |
Spaces after an Unordered List Item and any following text for a multiple line item. |
ol_multi |
integer | 1 |
Spaces after an Ordered List Item and any following text for a multiple line item. |
Origination of Rule#
This rule is largely inspired by the MarkdownLint rule MD030.