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

# MD023 - Headings Must Start at the Beginning of the Line

## Description

This rule ensures that all headings start at the beginning of the line, without any indentation.
Indented headings can cause inconsistent rendering across different Markdown processors.

<!-- markdownlint-disable -->
## Examples

### Valid

```markdown
# Heading 1
## Heading 2
### Heading 3
```

### Invalid

```markdown
   # Heading 1
  ## Heading 2
 ### Heading 3
```

### Fixed

```markdown
# Heading 1
## Heading 2
### Heading 3
```
<!-- markdownlint-enable -->

## Special Cases

- This rule applies to both ATX-style headings (with hash signs) and setext-style headings (underlined with = or -)
- It does not apply to headings in code blocks
- The rule checks for any whitespace (spaces or tabs) at the beginning of the line
- Indentation within the heading text after the hash signs is not affected by this rule

## Related Rules

- [MD001 - Heading increment](md001.md): Ensures heading levels increment by one level at a time
- [MD003 - Heading style](md003.md): Ensures consistent heading style
- [MD022 - Headings should be surrounded by blank lines](md022.md): Ensures proper spacing around headings