rumdl 0.0.12

A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)
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

# MD008 - Unordered List Style

This rule enforces consistent use of unordered list markers throughout a document.

## Description

Unordered lists in Markdown can use three different marker types:

- Asterisks (`*`)
- Plus signs (`+`)
- Hyphens/dashes (`-`)

For consistent styling across a document, this rule ensures all unordered list markers match the first marker found in the document. If no marker is found, it defaults to dash (`-`).

## Configuration

- `style`: Specifies a required marker style to use throughout the document regardless of what is found in the content. Available values:
  - `*`: Use asterisks for all unordered list items
  - `+`: Use plus signs for all unordered list items
  - `-`: Use hyphens/dashes for all unordered list items (default)

When no specific style is configured, the rule will automatically detect the first marker style used in the document and use that as the expected style for all list items.

## Examples

<!-- markdownlint-disable -->
### Valid

Using consistent asterisk style markers:

```markdown
* Item 1
* Item 2
  * Nested item
  * Another nested item
* Item 3
```

Using consistent dash style markers:

```markdown
- Item 1
- Item 2
  - Nested item
  - Another nested item
- Item 3
```

Using consistent plus style markers:

```markdown
+ Item 1
+ Item 2
  + Nested item
  + Another nested item
+ Item 3
```

### Invalid

Mixed marker styles:

```markdown
* Item 1
+ Item 2
  - Nested item
  * Another nested item
- Item 3
```

### Fixed

When the first marker style is asterisk:

```markdown
* Item 1
* Item 2
  * Nested item
  * Another nested item
* Item 3
```

When the first marker style is dash:

```markdown
- Item 1
- Item 2
  - Nested item
  - Another nested item
- Item 3
```

When the first marker style is plus:

```markdown
+ Item 1
+ Item 2
  + Nested item
  + Another nested item
+ Item 3
```
<!-- markdownlint-enable -->

## Special Cases

- Markers inside code blocks are ignored
- Configuring a specific style will override the auto-detection feature and enforce that style regardless of what is used in the document
- This rule works in harmony with MD004 (Unordered List Style) but focuses solely on marker character consistency

## Related Rules

- [MD004 - Unordered List Style](md004.md): Similar to MD008 but with more configuration options including "consistent mode"
- [MD005 - List Indentation](md005.md): Ensures consistent indentation in lists
- [MD007 - List Indent](md007.md): Enforces a specific indentation for list items

## Performance Considerations

The MD008 rule is optimized for efficiency, using simple character detection for marker recognition. It processes documents
line-by-line without regex, making it perform well even on large documents with many list items.