rumdl 0.3.2

A fast Markdown linter and formatter written in Rust
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

# MD067 - Footnote definition order

Aliases: `footnote-definition-order`

## What this rule does

Checks that footnote definitions appear in the same order as their first references in the document.

## Why this matters

- **Improves readability**: Readers expect footnotes in the order they encounter them
- **Reduces confusion**: Out-of-order footnotes make it harder to follow the document
- **Maintains consistency**: Ordered footnotes are easier to review and maintain

## Examples

### Correct

```markdown
Text with first[^1] and then second[^2] reference.

[^1]: Referenced first, defined first.
[^2]: Referenced second, defined second.
```

### Incorrect

```markdown
Text with first[^2] and then second[^1] reference.

[^1]: This is defined first but referenced second.
[^2]: This is defined second but referenced first.
```

**Warning**: `Footnote [^1] is defined before [^2] but referenced after it`

## Configuration

This rule has no configuration options.

## Automatic fixes

Run `rumdl fmt` or `rumdl check --fix` to reorder footnote definitions to match
their reference order. Each definition moves with its continuation paragraphs,
lists, and code blocks. Surrounding prose, blank-line separators, and unreferenced
definitions stay in their original positions.

Automatic fixes require unambiguous definition boundaries with matching
indentation within the same container. Duplicate labels, moves between separate
blockquotes or list items, comments immediately before or between definitions,
adjacent prose without a blank separator, MDX expressions or JSX/ESM syntax in
the affected region, and references inside definitions remain report-only:
moving these could change meaning or directive scope. Inline disables are
respected.

## Note on numbered footnotes

This rule checks definition order, not the footnote identifiers themselves.
You can use any identifiers you like (`[^1]`, `[^note]`, `[^ref-2024]`),
as long as the definitions appear in the order the references first occur.

## Related rules

- [MD066 - Footnote validation](md066.md)
- [MD068 - Empty footnote definitions](md068.md)