mdbook-lint 0.2.0

A fast markdown linter for mdBook
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

# Rules Reference

This page provides a comprehensive reference for all linting rules available in mdbook-lint.

## Standard Markdown Rules (MD001-MD059)

mdbook-lint implements 59 standard markdown linting rules based on the widely-used markdownlint specification.

### Heading Rules

#### MD001 - Heading levels should only increment by one level at a time
Ensures proper heading hierarchy in your documents.

```markdown
# Good
## Good

# Bad
### Bad (skips level 2)
```

#### MD003 - Heading style
Enforces consistent heading styles throughout your document.

#### MD018 - No space after hash on atx style heading
Requires a space after the hash in ATX-style headings.

#### MD019 - Multiple spaces after hash on atx style heading
Prevents multiple spaces after the hash in ATX-style headings.

### List Rules

#### MD004 - Unordered list style
Enforces consistent marker style for unordered lists.

#### MD005 - Inconsistent indentation for list items at the same level
Ensures consistent indentation within lists.

#### MD007 - Unordered list indentation
Controls indentation levels for nested lists.

### Line Rules

#### MD009 - Trailing whitespace
Removes unnecessary whitespace at the end of lines.

#### MD010 - Hard tabs
Prevents the use of hard tab characters.

#### MD012 - Multiple consecutive blank lines
Limits consecutive blank lines.

#### MD013 - Line length
Enforces maximum line length limits.

### Link Rules

#### MD034 - Bare URL used
Requires proper link formatting for URLs.

#### MD039 - Spaces inside link text
Prevents spaces around link text.

## mdBook-Specific Rules (MDBOOK001-004)

These rules are specifically designed for mdBook projects and check mdBook-specific syntax and conventions.

### MDBOOK001 - SUMMARY.md structure
Validates the structure of your SUMMARY.md file according to mdBook conventions.

### MDBOOK002 - Internal link validation
Checks that internal links reference valid files and sections within your book.

### MDBOOK003 - Missing referenced files
Ensures all files referenced in SUMMARY.md actually exist.

### MDBOOK004 - mdBook syntax validation
Validates mdBook-specific markdown syntax and features.

## Rule Configuration

Many rules can be customized through configuration. See the [Configuration Reference](./configuration-reference.md) for details.

### Example Rule Configuration

```toml
[rules.MD013]
line-length = 120
code-blocks = false

[rules.MD007]
indent = 2
```

## Disabling Rules

Rules can be disabled globally or for specific files:

```toml
# Disable globally
disabled-rules = ["MD013", "MD033"]
```

```markdown
<!-- mdbook-lint-disable MD013 -->
This line can be very long and won't trigger the line length rule.
<!-- mdbook-lint-enable MD013 -->
```

## Getting Help

To see all available rules with descriptions:

```bash
mdbook-lint rules --detailed
```

To see only enabled rules:

```bash
mdbook-lint rules --enabled
```

## Next Steps

- Learn about [Configuration Reference](./configuration-reference.md)
- Explore [CLI Usage](./cli-usage.md) for rule-specific commands
- Check [Contributing](./contributing.md) to request new rules