mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-16 14:00:13 +01:00
Refactor MD012 documentation for clarity
Removed excessive blank lines and cleaned up examples.
This commit is contained in:
parent
6a6fa32a7e
commit
25dc0f1a2f
1 changed files with 5 additions and 24 deletions
29
doc/md012.md
29
doc/md012.md
|
|
@ -1,38 +1,19 @@
|
||||||
# `MD012` - Multiple consecutive blank lines
|
# `MD012` - Multiple consecutive blank lines
|
||||||
|
|
||||||
Tags: `blank_lines`, `whitespace`
|
Tags: `blank_lines`, `whitespace`
|
||||||
|
|
||||||
Aliases: `no-multiple-blanks`
|
Aliases: `no-multiple-blanks`
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `maximum`: Consecutive blank lines (`integer`, default `1`)
|
- `maximum`: Consecutive blank lines (`integer`, default `1`)
|
||||||
|
|
||||||
Fixable: Some violations can be fixed by tooling
|
Fixable: Some violations can be fixed by tooling
|
||||||
|
|
||||||
This rule is triggered when there are multiple consecutive blank lines in the
|
This rule is triggered when there are multiple consecutive blank lines in the
|
||||||
document:
|
document```markdown
|
||||||
|
Some text her
|
||||||
```markdown
|
Some more text here``
|
||||||
|
To fix this, delete the offending lines:```markdown
|
||||||
Some text here
|
Some text here
|
||||||
|
Some more text here``
|
||||||
|
|
||||||
Some more text here
|
|
||||||
```
|
|
||||||
|
|
||||||
To fix this, delete the offending lines:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
Some text here
|
|
||||||
|
|
||||||
Some more text here
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: this rule will not be triggered if there are multiple consecutive blank
|
Note: this rule will not be triggered if there are multiple consecutive blank
|
||||||
lines inside code blocks.
|
lines inside code blocks.
|
||||||
|
|
||||||
Note: The `maximum` parameter can be used to configure the maximum number of
|
Note: The `maximum` parameter can be used to configure the maximum number of
|
||||||
consecutive blank lines.
|
consecutive blank lines.
|
||||||
|
|
||||||
Rationale: Except in a code block, blank lines serve no purpose and do not
|
Rationale: Except in a code block, blank lines serve no purpose and do not
|
||||||
affect the rendering of content.
|
affect the rendering of content.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue