rumdl 0.0.138

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

# MD050 - Keep bold text formatting consistent

## What this rule does

Ensures all bold text uses the same style throughout your document - either double asterisks (**) or double underscores (__).

## Why this matters

- **Professional appearance**: Mixed bold styles make documents look unpolished and carelessly edited
- **Reading flow**: Consistent formatting reduces visual distractions for readers
- **Team collaboration**: Standard formatting makes it easier for teams to work together
- **Parser compatibility**: Some Markdown parsers may handle different styles differently

## Examples

<!-- rumdl-disable MD050 -->

### ✅ Correct (consistent asterisks)

```markdown
This text has **bold** formatting.

Another paragraph with **important** text.

Even more **emphasized** content here.
```

### ✅ Correct (consistent underscores)

```markdown
This text has __bold__ formatting.

Another paragraph with __important__ text.

Even more __emphasized__ content here.
```

### ❌ Incorrect (mixed styles)

```markdown
This text has **bold** formatting.

Another paragraph with __important__ text.

Even more **emphasized** content here.
```

### 🔧 Fixed

```markdown
This text has **bold** formatting.

Another paragraph with **important** text.

Even more **emphasized** content here.
```

<!-- rumdl-enable MD050 -->

## Configuration

```yaml
MD050:
  style: "consistent"  # Options: "consistent", "asterisk", "underscore"
```

### Style options

- **`consistent`** (default): Use whatever style appears first in your document
- **`asterisk`**: Always use `**text**` for bold
- **`underscore`**: Always use `__text__` for bold

## Automatic fixes

This rule can automatically fix issues by:

- Converting all bold markers to match your configured style
- When using "consistent", converting all markers to match the first one found

## Learn more

- [CommonMark strong emphasis specification](https://spec.commonmark.org/0.31.2/#emphasis-and-strong-emphasis)
- [Markdown Guide: Bold](https://www.markdownguide.org/basic-syntax/#bold)

## Related rules

- [MD049 - Keep italic text formatting consistent](md049.md)
- [MD036 - Use proper headings instead of emphasized text](md036.md)
- [MD037 - Remove spaces inside emphasis markers](md037.md)