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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# MD036 - No Emphasis as Heading

## Description

This rule ensures that emphasis (bold or italic) is not used as a substitute for proper headings.  
Using emphasis to create headings can lead to inconsistent document structure and accessibility issues.

Proper headings provide better document structure, are more accessible, and enable automatic  
generation of tables of contents.

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

### Valid

```markdown
# This is a proper heading

## This is another proper heading

This is a paragraph with **bold** and *italic* text within it.
```

### Invalid

```markdown
**This is not a proper heading**

*This is not a proper heading either*

***This is definitely not a proper heading***
```

### Fixed

```markdown
## This is not a proper heading

## This is not a proper heading either

### This is definitely not a proper heading
```
<!-- markdownlint-enable -->

## Configuration

This rule has the following configuration options:

- `punctuation`: A string containing the punctuation characters that are allowed at the end of emphasized text without triggering this rule. Default is `".,;:!?"`.

## Special Cases

- This rule only applies to emphasis that appears alone on a line
- Emphasis within other content is not affected
- Both single emphasis (*italic*) and double emphasis (**bold**) are checked
- Triple emphasis (***bold italic***) is also checked
- The rule can be configured to allow certain punctuation at the end of emphasized text

## 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
- [MD018 - No missing space in ATX heading](md018.md): Ensures proper spacing in headings