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

# MD054 - Link Style

## Description

This rule enforces a consistent style for Markdown links. Markdown supports several different link styles, and this rule helps maintain consistency throughout a document.

## Configuration

This rule has the following configuration options:

- `style`: The style of links to enforce. Can be one of:
  - `"consistent"`: Enforce the first link style used in the document (default)
  - `"specified"`: Enforce the styles specified in the `styles` array

- `styles`: An array of allowed link styles when `style` is set to `"specified"`. Can include any of:
  - `"autolink"`: Allow `<https://example.com>` style links
  - `"collapsed"`: Allow `[example][]` style references
  - `"full"`: Allow `[example][reference]` style references
  - `"inline"`: Allow `[example](url)` style links
  - `"shortcut"`: Allow `[example]` style references

Example configuration:

```json
{
  "MD054": {
    "style": "specified",
    "styles": ["inline", "autolink"]
  }
}
```

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

### Valid

When style is set to "inline":

```markdown
[Example link](https://example.com)
```

When style is set to "autolink":

```markdown
<https://example.com>
```

When style is set to "collapsed":

```markdown
[Example][]

[Example]: https://example.com
```

When style is set to "full":

```markdown
[Example][reference]

[reference]: https://example.com
```

### Invalid

When style is set to "inline" but using reference style:

```markdown
[Example][reference]

[reference]: https://example.com
```

### Fixed

```markdown
[Example](https://example.com)
```
<!-- markdownlint-enable -->

## Special Cases

- When style is set to "consistent", the first link style used in the document is enforced
- The rule checks all links in the document, including those in headings, lists, and blockquotes
- Links in code blocks are ignored
- The rule does not apply to image links

## Related Rules

- [MD042 - No Empty Links](md042.md): Ensures links have content
- [MD034 - No Bare URLs](md034.md): Ensures URLs are properly formatted
- [MD039 - No Space in Links](md039.md): Ensures proper link syntax