MD032- 列表应由空行包围
标签:blank_lines,bullet,ol,ul
别名:blanks-around-lists
可修复:一些违规行为可以通过工具修复
列表(有序、无序)前后需要用空行隔开,否则有些解释器不会解释为列表,列表的缩进必须一致,否则会警告
当列表(任何类型)前面或后面没有空行时,会触发此规则:
Some text
* Some
* List
1. Some
2. List
Some text
在上面的第一种情况下,文本紧接在无序列表之前。在上面的第二种情况中,主题中断紧随有序列表之后。要修复违反此规则的问题,请确保所有列表前后都有空行(列表位于文档的开头或末尾时除外):
Some text
* Some
* List
1. Some
2. List
Some text
理由:除了美观原因之外,一些解析器(包括 kramdown)不会解析前后没有空行的列表。
注意:没有悬挂缩进的列表项违反了此规则;带有悬挂缩进的列表项是可以的:
* This is
not okay
* This is
okay
请注意,以下情况不违反本规则:
1. List item
More item 1
2. List item
More item 2
尽管没有缩进,但文本“More item 2”被称为 惰性延续行,并被视为第二个列表项的一部分。
理由:除了美观原因之外,一些解析器(包括 kramdown)不会解析前后没有空行的列表。