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

# CLI Usage

This page documents the command-line interface for mdbook-lint.

## Basic Commands

### lint
Lint markdown files and directories.

```bash
mdbook-lint lint [OPTIONS] [PATHS]...
```

### rules
List available linting rules.

```bash
mdbook-lint rules [OPTIONS]
```

### help
Show help information.

```bash
mdbook-lint help [COMMAND]
```

## Options

### Global Options

- `-h, --help`: Print help information
- `-V, --version`: Print version information
- `-v, --verbose`: Enable verbose output
- `-q, --quiet`: Suppress non-error output

### Lint Options

- `--config <FILE>`: Use specific configuration file
- `--fail-on-warnings`: Exit with error code on warnings
- `--disable <RULES>`: Disable specific rules (comma-separated)

### Rules Options

- `--detailed`: Show detailed rule descriptions
- `--enabled`: Show only enabled rules
- `--format <FORMAT>`: Output format (text, json)

## Examples

```bash
# Lint current directory
mdbook-lint lint .

# Lint specific files
mdbook-lint lint README.md src/chapter1.md

# Lint with custom config
mdbook-lint lint --config custom-lint.toml src/

# Show all rules with descriptions
mdbook-lint rules --detailed

# Lint and fail on warnings
mdbook-lint lint --fail-on-warnings docs/
```

## Exit Codes

- `0`: Success (no errors)
- `1`: Linting errors found
- `2`: Invalid arguments or configuration

## Next Steps

- Learn about [mdBook Integration](./mdbook-integration.md)
- See [Configuration Reference](./configuration-reference.md) for all options