markdown规则详细介绍及自定义参数设置:

本文详细介绍了Markdown的规则,包括标题级数、标题样式、列表格式等,并提供了自定义参数设置,如MD001规定标题级数每次只能递增1,MD003要求整篇文档标题风格一致,MD046则规定了代码块的格式风格。
摘要由CSDN通过智能技术生成

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

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值