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

# MD017 - No Emphasis as Heading

## Description

This rule prevents the use of emphasis (italic or bold) as a substitute for proper headings.  
Using emphasis to create headings can lead to inconsistent document structure and accessibility issues.

## Configuration

- `allow*emphasis*headings`: Whether to allow emphasis as headings (default: false)

## Examples

<!-- markdownlint-disable -->
### Valid

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

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

### 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 -->

## Special Cases

- This rule only flags 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

## 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