rumdl 0.1.51

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

# MD023 - Start headings at the beginning of lines

Aliases: `heading-start-left`

## What this rule does

Checks that headings start at the beginning of the line without any indentation.

## Why this matters

- **Proper rendering**: Indented headings may not be recognized by all Markdown processors
- **Clear structure**: Headings at the line start make document hierarchy obvious
- **Consistency**: Uniform alignment creates a professional appearance
- **Avoid confusion**: Indented text with # symbols might be misinterpreted

## Examples

<!-- rumdl-disable MD023 -->

### ✅ Correct

```markdown
# Main Title
## Section Header
### Subsection
#### Detail Level
```

### ❌ Incorrect

```markdown
   # Main Title
  ## Section Header
 ### Subsection
    #### Detail Level
```

### 🔧 Fixed

```markdown
# Main Title
## Section Header
### Subsection
#### Detail Level
```

<!-- rumdl-enable MD023 -->

## Automatic fixes

This rule automatically removes any leading spaces or tabs from heading lines, moving them to the beginning of the line.

## Learn more

- [CommonMark specification for headings](https://spec.commonmark.org/0.31.2/#atx-headings)
- [Markdown heading best practices](https://www.markdownguide.org/basic-syntax/#headings)

## Related rules

- [MD001](md001.md): Use consistent heading levels
- [MD003](md003.md): Use consistent heading style
- [MD022](md022.md): Add blank lines around headings
- [MD026](md026.md): Remove trailing punctuation in headings