Skip to content

Commit d7abf05

Browse files
committed
Add better description to list-item-spacing
Closes GH-78.
1 parent 0e178ac commit d7abf05

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

doc/rules.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1112,6 +1112,11 @@ When `'invalid'` is passed in, the following error is given:
11121112
Warn when list looseness is incorrect, such as being tight
11131113
when it should be loose, and vice versa.
11141114

1115+
According the [markdown-style-guide](http://www.cirosantilli.com/markdown-style-guide/),
1116+
if one or more list-items in a list spans more than one line,
1117+
the list is required to have blank lines between each item.
1118+
And otherwise, there should not be blank lines between items.
1119+
11151120
When this rule is turned on, the following file
11161121
`valid.md` is ok:
11171122

lib/rules/list-item-spacing.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
* Warn when list looseness is incorrect, such as being tight
88
* when it should be loose, and vice versa.
99
*
10+
* According the [markdown-style-guide](http://www.cirosantilli.com/markdown-style-guide/),
11+
* if one or more list-items in a list spans more than one line,
12+
* the list is required to have blank lines between each item.
13+
* And otherwise, there should not be blank lines between items.
14+
*
1015
* @example {"name": "valid.md"}
1116
*
1217
* A tight list:

0 commit comments

Comments
 (0)