rumdl 0.0.12

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

# MD031 - Fenced Code Blocks Should Be Surrounded by Blank Lines

## Description

This rule ensures that fenced code blocks are surrounded by blank lines. Adding blank lines before and after  
fenced code blocks improves readability and ensures proper rendering across different Markdown processors.

<!-- markdownlint-disable -->
## Examples

### Valid

```markdown
Text before the code block.

```markdown
Code block content
```

Text after the code block.
```

### Invalid

```markdown
Text before the code block.
```markdown
Code block content
```
Text after the code block.
```

### Fixed

```markdown
Text before the code block.

```markdown
Code block content
```

Text after the code block.
```
<!-- markdownlint-enable -->

## Configuration

This rule has the following configuration options:

- `list_items`: Whether to require blank lines around fenced code blocks in list items. Default is `true`.

## Special Cases

- This rule applies to both fenced code blocks (using backticks or tildes)
- It checks for blank lines both before and after code blocks
- When `list_items` is set to `false`, code blocks in list items are exempt from this rule

## Related Rules

- [MD032 - Lists should be surrounded by blank lines](md032.md): Similar rule for lists
- [MD040 - Fenced code blocks should have a language specified](md040.md): Ensures code blocks specify a language
- [MD046 - Code block style](md046.md): Ensures consistent code block style