rumdl 0.2.62

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

# MD026 - Keep headings clean and professional

Aliases: `no-trailing-punctuation`

## What this rule does

Removes trailing punctuation from the end of headings to maintain a clean, professional appearance. Question marks are allowed by default for FAQ-style headings.

## Why this matters

- **Professional appearance**: Clean headings look more polished and professional
- **Better readability**: Unnecessary punctuation can distract readers
- **Consistent style**: Maintains a uniform look throughout your document
- **Navigation clarity**: Clean headings work better in tables of contents and outlines

## Examples

### ✅ Correct

```markdown
# Introduction

## What is Markdown?

### FAQ: Frequently Asked Questions

#### Step 1: Getting Started

##### Chapter 2: Configuration
```

### ❌ Incorrect

<!-- rumdl-disable MD026 -->

```markdown
# This is a sentence.

## Random heading;

### This seems wrong,

#### Important!

##### Ending with colon:
```

<!-- rumdl-enable MD026 -->

### 🔧 Fixed

```markdown
# This is a sentence

## Random heading

### This seems wrong

#### Important

##### Ending with colon
```

## Configuration

```toml
[MD026]
punctuation = ".,;:!"  # Characters to remove from heading endings (default: ".,;:!")
```

To allow exclamation marks in headings, remove `!` from the list:

```toml
[MD026]
punctuation = ".,;:"
```

## Automatic fixes

This rule will:

- Remove periods, commas, semicolons, colons, and exclamation marks from heading endings (default: `.,;:!`)
- Preserve question marks for FAQ-style headings ("What is Markdown?")
- You can customize the punctuation list if you want to allow certain characters

## Markdown with Gherkin

Under the `mdg` flavor, the ASCII colon leaves the `punctuation` set, whether it
arrived from the default or from an explicit configuration. A Gherkin structure
is an ATX heading spelled `Keyword: name`, so the colon after the keyword is
what makes the keyword a keyword, and this rule must never be able to delete it.

Because MD026 matches punctuation only at the very end of a heading, dropping
the colon from the set is complete: no heading whose last character is a colon
is inspected at all, so `## Scenario!:` is left exactly as written. Only the
ASCII colon leaves the set — a full-width `：` carries no structural meaning, so
a `punctuation` value that lists one keeps enforcing it.

When MD026 reaches relevant content with an explicit `punctuation` value
containing a colon, it prints one `[config warning]` line on stderr; the colon
is dropped either way.

See [Markdown with Gherkin Flavor](flavors/mdg.md) for the full flavor
specification.

## Learn more

- [CommonMark Spec: ATX headings](https://spec.commonmark.org/0.31.2/#atx-headings)
- [CommonMark Spec: Setext headings](https://spec.commonmark.org/0.31.2/#setext-headings)

## Related rules

- [MD001 - Keep heading levels organized](md001.md)
- [MD003 - Use consistent heading styles](md003.md)
- [MD025 - Keep your document organized with one main title](md025.md)