Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 22:10:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Allow opt-out for list items with blank lines in MD009/no-trailing-spaces (fixes #55).

Browse source
This commit is contained in:
David Anson 2017-05-11 21:44:41 -07:00
parent b436640918
commit d826833a82
7 changed files with 157 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
doc/Rules.md
View file

@ -254,20 +254,28 @@ Tags: whitespace
Aliases: no-trailing-spaces
Parameters: br_spaces (number; default 0)
Parameters: br_spaces, list_item_empty_lines (number; default 0, boolean; default false)
This rule is triggered on any lines that end with whitespace. To fix this,
find the line that is triggered and remove any trailing spaces from the end.
The br_spaces parameter allows an exception to this rule for a specific amount
The `br_spaces` parameter allows an exception to this rule for a specific amount
of trailing spaces used to insert an explicit line break/br element. For
example, set br_spaces to 2 to allow exactly 2 spaces at the end of a line.
example, set `br_spaces` to 2 to allow exactly 2 spaces at the end of a line.
Note: you have to set br_spaces to 2 or higher for this exception to take
Note: you have to set `br_spaces` to 2 or higher for this exception to take
effect - you can't insert a br element with just a single trailing space, so
if you set br_spaces to 1, the exception will be disabled, just as if it was
if you set `br_spaces` to 1, the exception will be disabled, just as if it was
set to the default of 0.
Using spaces to indent blank lines inside a list item is usually not necessary,
but some parsers require it. Set the `list_item_empty_lines` parameter to `true`
to allow this:
- list item text
list item text
<a name="md010"></a>
## MD010 - Hard tabs