rumdl 0.3.0

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

# MD037 - Review spaces in apparent emphasis

Aliases: `no-space-in-emphasis`

## What this rule does

Reports spaces between apparent emphasis markers (*asterisks* or *underscores*) and their text for manual review. Spaced markers can also be intentional literal characters, such as multiplication signs.

## Why this matters

Spaced markers may be accidental formatting or intentional literal text. Review
the diagnostic to make your intent clear without changing document meaning.

## Examples

<!-- rumdl-disable MD037 -->

### ✅ Correct

Emphasis markers directly touch the text:

```markdown
This is *italic* text.

This is **bold** text.

This is ***bold italic*** text.

Using _underscores_ also works.
```

### ⚠️ Flagged

Spaced markers that are reported:

```markdown
This is * italic with spaces * text.

This is ** bold with spaces ** text.

This is * space at start* text.

This is *space at end * text.
```

### Manually corrected

If emphasis was intended, remove the spaces manually:

```markdown
This is *italic with spaces* text.

This is **bold with spaces** text.

This is *space at start* text.

This is *space at end* text.
```

<!-- rumdl-enable MD037 -->

## Configuration

This rule has no configuration options.

## Special cases

`*` and `_` inside a template shortcode tag (`{{% a * y * b %}}`,
`{{< a * y * b >}}`) are literal characters the template receives as arguments,
not emphasis markers, so they are not reported. Only the tag is
exempt: the body between a paired opening and closing shortcode is ordinary
Markdown and is still checked.

## Automatic fixes

This rule does not offer automatic fixes. Under CommonMark, whitespace next to
an opening or closing marker prevents that marker from opening or closing
emphasis. Removing the whitespace can create formatting the author never
intended: `parts * 3 * the part size` would become `parts *3* the part size`,
turning a literal multiplication expression into italics.

Review the warning manually. If you intended emphasis, remove the inner spaces.
If the markers are literal, escape them (for example, `parts \* 3 \* the part size`),
use a code span, or suppress MD037 for that text. `rumdl check --fix`, `rumdl fmt`,
and editor quick fixes leave these pairs unchanged.

## Learn more

- [CommonMark specification for emphasis](https://spec.commonmark.org/0.31.2/#emphasis-and-strong-emphasis)

## Related rules

- [MD049 - Emphasis style](md049.md) - Choose between asterisks or underscores
- [MD050 - Strong style](md050.md) - Choose bold marker style
- [MD036 - No emphasis as heading](md036.md) - Use real headings instead of bold text