rumdl 0.0.137

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

# MD010 - Use spaces instead of tabs

## What this rule does

Replaces tab characters with spaces to ensure consistent indentation across all editors and platforms.

## Why this matters

- **Consistency**: Tabs display differently in different editors (2, 4, or 8 spaces wide)
- **Team collaboration**: Mixed tabs and spaces create confusing indentation and merge conflicts
- **Tool compatibility**: Many Markdown tools and platforms expect spaces for proper formatting
- **Readability**: Consistent spacing makes documents easier to read and maintain

## Examples

### ✅ Correct

```markdown
* Shopping list
  * Fruits
    * Apples
    * Bananas
  * Vegetables
    * Carrots
    * Broccoli

    Remember to check for freshness!
```

### ❌ Incorrect

<!-- rumdl-disable MD010 -->

```markdown
* Shopping list
	* Fruits
		* Apples
		* Bananas
	* Vegetables
		* Carrots
		* Broccoli

	Remember to check for freshness!
```

<!-- rumdl-enable MD010 -->

### 🔧 Fixed

```markdown
* Shopping list
    * Fruits
        * Apples
        * Bananas
    * Vegetables
        * Carrots
        * Broccoli

    Remember to check for freshness!
```

## Configuration

```yaml
MD010:
  spaces_per_tab: 4                     # Number of spaces to replace each tab with (default: 4)
```

### Configuration options explained

- `spaces_per_tab`: How many spaces to use when replacing each tab character

## Automatic fixes

This rule automatically replaces each tab character with the configured number of spaces (default: 4). This ensures your document looks the same in every editor.

## Learn more

- [Tabs vs Spaces](https://www.markdownguide.org/basic-syntax/#tabs) - Why spaces are preferred in Markdown
- [CommonMark specification](https://spec.commonmark.org/0.31.2/#tabs) - Technical details about tab handling

## Related rules

- [MD009](md009.md) - Remove trailing spaces
- [MD007](md007.md) - Keep list indentation consistent
- [MD005](md005.md) - Keep list indentation consistent