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

# MD044 - Proper Names

## Description

This rule ensures that proper names are consistently capitalized throughout a document. This helps maintain  
consistency and professionalism in technical documentation.

The rule can be configured with a list of proper names and their correct capitalization.

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

### Valid

With configuration `names: ["JavaScript", "Node.js", "GitHub"]`:

```markdown
# JavaScript Development Guide

This guide covers JavaScript and Node.js development practices for GitHub projects.
```

### Invalid

With the same configuration:

```markdown
# Javascript Development Guide

This guide covers javascript and nodejs development practices for github projects.
```

### Fixed

```markdown
# JavaScript Development Guide

This guide covers JavaScript and Node.js development practices for GitHub projects.
```
<!-- markdownlint-enable -->

## Configuration

This rule has the following configuration options:

- `names`: An array of strings representing proper names with their correct capitalization. Default is an empty array.
- `code_blocks`: Whether to check code blocks for proper names. Default is `true`.
- `html_elements`: Whether to check HTML elements for proper names. Default is `true`.

Example configuration:

```json
{
  "MD044": {
    "names": ["JavaScript", "Node.js", "GitHub"],
    "code_blocks": false,
    "html_elements": true
  }
}
```

## Special Cases

- This rule only applies when the `names` array is not empty
- The rule performs case-sensitive matching
- When `code_blocks` is `false`, proper names in code blocks are not checked
- When `html_elements` is `false`, proper names in HTML elements are not checked
- The rule does not check proper names in URLs or image paths

## Related Rules

- [MD033 - No inline HTML](md033.md): Ensures no inline HTML is used
- [MD040 - Fenced code blocks should have a language specified](md040.md): Ensures code blocks specify a language
- [MD049 - Emphasis style](md049.md): Ensures consistent style for emphasis markers