Markdown
MarkdownLint 错误
Md025

MD025 - 同一文档中的多个顶级标题

标签: 标题

别名:single-h1

参数:level(数字;默认1)

同一个文档中,只能有一个最高级的标题,默认也只能有一个一级标题

当使用顶级标头(文件的第一行是 h1 标头)并且文档中使用多个 h1 标头时,会触发此规则:

# Top level header
 
# Another top level header

要修复此问题,请构建文档,以便有一个 h1 标题作为文档的标题,并且所有后续标题都是 h2 或更低级别的标题:

# Title
 
## Header
 
## Another header

基本原理:顶级标头是文件第一行的 h1,用作文档的标题。如果使用这一约定,则该文档不能有多个标题,并且整个文档应包含在该标题中。

注意:level在外部添加 h1 的情况下,该参数可用于更改顶层(例如:更改为 h2)。