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

# MD058 - Add blank lines around tables

Aliases: `blanks-around-tables`

## What this rule does

Ensures tables have blank lines before and after them for better readability and proper rendering.

## Why this matters

- **Clear visual separation**: Tables stand out better with surrounding space
- **Parser compatibility**: Some Markdown parsers require blank lines to recognize tables
- **Improved readability**: Easier to scan documents and find information
- **Consistent formatting**: Maintains uniform spacing throughout documents

## Examples

### ✅ Correct

```markdown
Here's our team structure:

| Name    | Department | Role      |
| ------- | ---------- | --------- |
| Alice   | Sales      | Manager   |
| Bob     | IT         | Developer |

As you can see, we have a diverse team.
```

### ❌ Incorrect

```markdown
Here's our team structure:
| Name    | Department | Role      |
| ------- | ---------- | --------- |
| Alice   | Sales      | Manager   |
| Bob     | IT         | Developer |
As you can see, we have a diverse team.
```

### 🔧 Fixed

```markdown
Here's our team structure:

| Name    | Department | Role      |
| ------- | ---------- | --------- |
| Alice   | Sales      | Manager   |
| Bob     | IT         | Developer |

As you can see, we have a diverse team.
```

## Configuration

```toml
[MD058]
minimum-before = 1  # Blank lines before table
minimum-after = 1  # Blank lines after table
```

### Examples with different settings

```toml
[MD058]
minimum-before = 2  # Require 2 blank lines before
minimum-after = 1  # Require 1 blank line after
```

## Automatic fixes

This rule can automatically fix issues by:

- Adding blank lines before tables (unless at document start)
- Adding blank lines after tables (unless at document end)
- Adding the exact number of blank lines specified in configuration

## Learn more

- [Markdown Guide: Tables](https://www.markdownguide.org/extended-syntax/#tables)
- [GitHub Flavored Markdown: Tables](https://github.github.com/gfm/#tables-extension-)

## Related rules

- [MD055 - Keep table formatting consistent](md055.md)
- [MD056 - Keep table column count consistent](md056.md)