MD003 - 标题样式
标签: 标题
别名:标题样式
参数:样式(:consistent
,:atx
,:atx_closed
,:setext
, :setext_with_atx
;默认:consistent
)
当同一文档中使用不同的标头样式(atx、setext
和 'close' atx
)时,会触发此规则:
整篇文档的标题格式要采取统一的。
# ATX style H1
## Closed ATX style H2 ##
Setext style H1
===============
与文档中使用的标题样式保持一致:
# ATX style H1
## ATX style H2
setext_with_atx
文档样式允许在具有 setext
样式标题的文档中使用 3 级或更高级别的 atx 样式标题:
Setext style H1
===============
Setext style H2
---------------
### ATX style H3
注意:配置的标头样式可以是要使用的特定样式(atx、atx_close、setext、setext_with_atx
),或者只是要求文档内的用法保持一致。