rumdl 0.1.51

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
109
110
111
112
113

# MD074 - MkDocs nav validation

Aliases: `mkdocs-nav`

## What this rule does

Validates that MkDocs navigation entries in `mkdocs.yml` point to existing files. This rule only runs when the markdown flavor is set to `mkdocs`.

## Why this matters

- **Prevents broken navigation**: Ensures all nav entries resolve to actual documentation files
- **Catches typos**: Common mistakes in file paths are caught before deployment
- **Maintains site structure**: Helps keep your MkDocs site organized and complete

## Examples

Given this `mkdocs.yml`:

```yaml
site_name: My Docs
docs_dir: docs
nav:
  - Home: index.md
  - Guide: guide.md
  - API:
    - Overview: api/overview.md
    - Reference: api/reference.md
```

### ✅ Correct

All referenced files exist in the `docs/` directory:

- `docs/index.md`
- `docs/guide.md`
- `docs/api/overview.md`
- `docs/api/reference.md`

Directory nav entries like `- Section: section/` are valid if `section/index.md` exists.

### ❌ Incorrect

```yaml
nav:
  - Home: index.md
  - Guide: missing-guide.md      # File doesn't exist
  - API:
    - Overview: /api/overview.md  # Absolute path (if configured to warn)
```

### 🔧 Fixed

This rule cannot automatically fix broken nav entries. You must manually:

- Fix typos in file paths
- Create missing documentation files
- Update nav structure after moving files

## Configuration

### `not-found`

How to handle nav entries pointing to non-existent files.

| Value            | Behavior          |
| ---------------- | ----------------- |
| `warn` (default) | Report a warning  |
| `ignore`         | Skip validation   |

### `omitted-files`

How to handle files in `docs_dir` that aren't referenced in nav.

| Value              | Behavior                |
| ------------------ | ----------------------- |
| `warn`             | Report files not in nav |
| `ignore` (default) | Skip this check         |

### `absolute-links`

How to handle absolute links (starting with `/`) in nav entries.

| Value              | Behavior         |
| ------------------ | ---------------- |
| `warn`             | Report a warning |
| `ignore` (default) | Skip validation  |

### Example configuration

```toml
# .rumdl.toml
[global]
flavor = "mkdocs"

[MD074]
not-found = "warn"
omitted-files = "warn"
absolute-links = "warn"
```

## Automatic fixes

This rule does not provide automatic fixes. Missing nav entries must be corrected manually.

## Learn more

- [MkDocs Navigation](https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation)
- [MkDocs Configuration](https://www.mkdocs.org/user-guide/configuration/)

## Related rules

- [MD057 - Check that file links work](md057.md)
- [MD051 - Fix broken link fragments](md051.md)