MD030 - list-marker-space¶
Description¶
This rule checks the number of spaces between list markers (such as -, *, +, or 1.) and the text of list items. It supports different spacing requirements for single-paragraph and multi-paragraph list items.
Rationale¶
Consistent spacing after list markers improves readability and ensures documents render correctly across different Markdown parsers. Some style guides require additional spaces for multi-paragraph list items to align continuation paragraphs.
Configuration¶
ul_single-
Spaces after unordered list markers for single-paragraph items.
- Default:
1
- Default:
ol_single-
Spaces after ordered list markers for single-paragraph items.
- Default:
1
- Default:
ul_multi-
Spaces after unordered list markers for multi-paragraph items.
- Default:
1
- Default:
ol_multi-
Spaces after ordered list markers for multi-paragraph items.
- Default:
1
- Default:
Examples¶
Invalid¶
# Invalid List Marker Spacing
- Item with two spaces
- Item with three spaces
1. First item with two spaces
2. Second item with three spaces
Valid¶
# Valid List Marker Spacing
- Item one
- Item two
- Item three
1. First item
2. Second item
3. Third item