rumdl 0.2.75

A fast Markdown linter and formatter written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

# MD032 - Separate lists with blank lines

Aliases: `blanks-around-lists`

## What this rule does

Ensures lists have blank lines before and after them, making them visually distinct from surrounding content.

## Why this matters

- **Reliable parsing**: Many Markdown parsers require blank lines to properly recognize lists
- **Visual clarity**: Blank lines make lists stand out from paragraphs
- **Better readability**: Clear separation helps readers scan documents quickly
- **Consistent rendering**: Prevents lists from merging with adjacent content

## Examples

### ✅ Correct

```markdown
Text before the list.

* Item 1
* Item 2
* Item 3

Text after the list.
```

### ❌ Incorrect

<!-- rumdl-disable MD032 -->

```markdown
Text before the list.
* Item 1
* Item 2
* Item 3
Text after the list.
```

<!-- rumdl-enable MD032 -->

### 🔧 Fixed

```markdown
Text before the list.

* Item 1
* Item 2
* Item 3

Text after the list.
```

## Configuration

| Option                    | Type    | Default | Description                                                           |
| ------------------------- | ------- | ------- | --------------------------------------------------------------------- |
| `allow-lazy-continuation` | boolean | `true`  | Whether to allow lazy continuation (unindented text after list items) |

### Lazy continuation

By default, this rule allows "lazy continuation" - a CommonMark feature where unindented text following a list item becomes part of that list item:

```markdown
1. List item
Some text that continues the list item.
```

When `allow-lazy-continuation` is set to `false`, the rule requires a blank line between the list item and any following unindented text:

```toml
[MD032]
allow-lazy-continuation = false
```

With this setting, the above example would trigger a warning and be auto-fixed to:

```markdown
1. List item
   Some text that continues the list item.
```

The fix adds proper indentation to align with the list item's content column, making the continuation explicit rather than relying on lazy continuation behavior.

## Automatic fixes

This rule will:

- Add a blank line before lists that follow other content
- Add a blank line after lists that precede other content
- Handle nested lists correctly (only the outermost list needs surrounding blank lines)
- When `allow-lazy-continuation` is `false`: add proper indentation to lazy continuation lines

## HTML comments

A line holding nothing but an HTML comment counts as a blank line, so a comment
directly above or below a list satisfies this rule and `rumdl fmt` leaves the
document alone:

```markdown
Some text.
<!-- prettier-ignore -->
- First item
- Second item
```

This keeps a directive comment attached to what it applies to: inserting a blank
line there would turn the directive off.

The comment has to have the line to itself. `Some text. <!-- note -->` is a
paragraph, so a list written under it is still missing its blank line. A comment
spanning several lines counts at both ends, and the convention holds inside a
blockquote. [MD022](md022.md), [MD031](md031.md) and [MD058](md058.md) read
blank lines the same way.

## Learn more

- [CommonMark Spec: Lists](https://spec.commonmark.org/0.31.2/#lists)
- [CommonMark Spec: Blank lines](https://spec.commonmark.org/0.31.2/#blank-lines)

## Related rules

- [MD022 - Separate headings with blank lines](md022.md)
- [MD031 - Separate code blocks with blank lines](md031.md)
- [MD004 - Use consistent list markers](md004.md)
- [MD058 - Separate tables with blank lines](md058.md)