markdown规则详细介绍及自定义参数设置:
MD001 - Heading levels should only increment by one level at a time
标题级数每次只能扩大1, 也就是不能隔级创建标题(从1级到6级的顺序)
MD002 - First heading should be a top level heading
文档的第一个标题必须是最高级的标题(标题等级1级到6级逐渐降低)
参数:
“level”:指定最高级标题的级数,默认是1
MD003 - Heading style
整篇文档要采用一致的标题格式
参数:
“style”:字符串,指定文档标题的格式,有(“consistent”, “atx”, “atx_closed”, “setext”, “setext_with_atx”, “setext_with_atx_closed”)五种,默认是"consistent",也就是整篇文档一致
标题格式必须统一,一般不能混用,但"setext_with_atx", "setext_with_atx_closed"格式可以在"setext"格式二级标题后接着使用"atx"或"atx_closed"格式的标题
MD004 - Unordered list style
整篇文档定义无序列表的格式要一致
参数:
“style”:字符串,指定无序列表的定义格式,有(“consistent”, “asterisk”, “plus”, “dash”, “sublist”)五种,分别表示“定义时符号前后一致”,“用星号定义”,“用加号定义”,“用减号定义”,“定义多重列表时用不同的符号定义”,默认是"consistent"
MD005 - Inconsistent indentation for list items at the same level
同一级的列表缩进必须一致
在有序列表中,前面的数字序号可以左对齐,也可以右对齐
MD006 - Consider starting bulleted lists at the beginning of the line
1级列表不能缩进
MD007 - Unordered list indentation
无序列表嵌套缩进时默认采用两个空格
参数:
“ident”:指定无序列表嵌套时缩进的空格数,默认是2
MD009 - Trailing spaces
行尾最多可以添加两个空格,超过会给出警告,两个空格正好可以用于换行
参数:
“br_spaces”:指定在行尾可以添加的空格数目,空格数目建议大于等于2,如果小于2&#x