Markdown
MarkdownLint 错误
Md043

MD043- 所需的标题结构

标签：headings

别名：required-headings

参数：

  • headings：标题列表（string[]，默认[]）
  • match_case：匹配标题的大小写（boolean默认false）

要求标题遵循一定的结构，默认是没有规定的结构

当文件中的标题与传递给规则的标题数组不匹配时，将触发此规则。它可用于强制一组文件采用标准标题结构。

要求完全符合以下结构：

# Head
## Item
### Detail

将headings参数设置为：

[
    "# Head",
    "## Item",
    "### Detail"
]

允许使用以下结构的可选标题：

# Head
## Item
### Detail (optional)
## Foot
### Notes (optional)

使用表示“零个或多个未指定标题”的特殊值或表示“一个或多个未指定标题”的 "*"特殊值，并将参数设置为："+"headings

[
    "# Head",
    "## Item",
    "*",
    "## Foot",
    "*"
]

当检测到错误时，此规则输出第一个有问题的标题的行号（否则，它输出文件的最后一个行号）。

请注意，虽然headings为了简单起见参数使用“## Text”ATX 标题样式，但文件可以使用任何受支持的标题样式。

默认情况下，文档中标题的大小写不需要与headings。 如果要求大小写完全匹配，请将match_case 参数设置为true。

理由：项目可能希望在一组相似的内容中强制执行一致的文档结构。

Md042Md044