2022-10-30 15:13:19 -07:00
|
|
|
# `MD031` - Fenced code blocks should be surrounded by blank lines
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Tags: `blank_lines`, `code`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Aliases: `blanks-around-fences`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
2022-11-13 20:53:10 -08:00
|
|
|
- `list_items`: Include list items (`boolean`, default `true`)
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-12-16 13:53:03 -08:00
|
|
|
Fixable: Some violations can be fixed by tooling
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
|
This rule is triggered when fenced code blocks are either not preceded or not
|
|
|
|
|
followed by a blank line:
|
|
|
|
|
|
|
|
|
|
````markdown
|
|
|
|
|
Some text
|
|
|
|
|
```
|
|
|
|
|
Code block
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Another code block
|
|
|
|
|
```
|
|
|
|
|
Some more text
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
To fix this, ensure that all fenced code blocks have a blank line both before
|
|
|
|
|
and after (except where the block is at the beginning or end of the document):
|
|
|
|
|
|
|
|
|
|
````markdown
|
|
|
|
|
Some text
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Code block
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Another code block
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Some more text
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
Set the `list_items` parameter to `false` to disable this rule for list items.
|
|
|
|
|
Disabling this behavior for lists can be useful if it is necessary to create a
|
|
|
|
|
[tight](https://spec.commonmark.org/0.29/#tight) list containing a code fence.
|
|
|
|
|
|
|
|
|
|
Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will
|
|
|
|
|
not parse fenced code blocks that don't have blank lines before and after them.
|
