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

# MD043 - Required Headings

## Description

This rule ensures that a document contains a specific set of headings. This is useful for enforcing  
consistent document structure across a collection of documents, such as documentation or a knowledge base.

The rule can be configured with an array of required heading strings or regular expressions.

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

### Valid

With configuration `["# Introduction", "## Installation", "## Usage", "## License"]`:

```markdown
# Introduction

This is the introduction section.

## Installation

Installation instructions go here.

## Usage

Usage examples go here.

## License

This project is licensed under the MIT License.
```

### Invalid

With the same configuration:

```markdown
# Getting Started

This is the introduction section.

## How to Install

Installation instructions go here.

## Examples

Usage examples go here.

## License

This project is licensed under the MIT License.
```

### Fixed

```markdown
# Introduction

This is the introduction section.

## Installation

Installation instructions go here.

## Usage

Usage examples go here.

## License

This project is licensed under the MIT License.
```
<!-- markdownlint-enable -->

## Configuration

This rule has the following configuration options:

- `headings`: An array of strings or regular expressions representing the required headings. Default is an empty array.
- `match_case`: Whether to perform case-sensitive matching. Default is `false`.

Example configuration:

```json
{
  "MD043": {
    "headings": ["# Introduction", "## Installation", "## Usage", "## License"],
    "match_case": true
  }
}
```

## Special Cases

- This rule only applies when the `headings` array is not empty
- Regular expressions can be used by starting and ending the string with `/`
- The rule checks for exact matches unless regular expressions are used
- When `match_case` is `false`, the rule performs case-insensitive matching
- The rule does not check the order of headings unless specified in the configuration

## 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
- [MD025 - Single title/h1](md025.md): Ensures there's only one top-level heading