Markdown 标题

在Markdown语法中,标题支持使用两种标记:底线(-/=)和#。

Markdown标题 底线表示

使用底线的语法如下

使用底线的语法如下

语法说明如下。

  • 底线是=表示一级标题。

  • 底线是-表示二级标题。

  • 底线符号的数量至少2个。

  • 这种语法只支持这两级标题

实例演示如下。

使用底线的语法如下

Markdown标题#表示

Markdown标题

语法说明如下。

  1. 在行首插入#可标记出标题。
  2. #的个数表示了标题的等级。
  3. 建议在#后加一个空格。
  4. Markdown中最多只支持前六级标题。实例演示如下。

Markdown标题

使用规范

  1. 建议使用#标记标题,而不是===-,因为后者会难以阅读和维护。

推荐:

Markdown标题

不推荐:

Markdown标题

  1. 要保持间距,建议标题的前后都要空1行(除非标题在文档开头);#与标题文本之间也要有1个空格,否则会导致阅读困难。

推荐:

Markdown标题

不推荐:

Markdown标题

  1. 不要有多余的空格。建议标题要写在一行的开头,结尾也不要有空格。

推荐:

Markdown标题

不推荐:

Markdown标题

  1. 建议标题的结尾不要有标点符号,如句号、逗号、冒号、分号等。

推荐:

Markdown标题

不推荐:

Markdown标题

  1. 建议标题要尽量简短,这样方便引用,特别是当生成目录时。如果原拟的标题是一个长句,可以从长句中提取标题,而将长句作为标题下的内容。

推荐:

Markdown标题

不推荐:

Markdown标题

使用Markdown写文档比较推荐的结构如下。

Markdown标题

说明如下。

  1. 文档标题:文档的第一个标题应该是一级标题,写在第一行,建议与文件名相同,标题要尽量简短。
  2. 作者:可选,用于声明文档的作者,如果是开源项目的文档,建议把作者名写在修订历史中。
  3. 摘要:用1~3句话描述文档的核心内容。
  4. 目录:用于快速了解文档的结构,便于导航。
  5. 正文:正文中的标题从二级目录开始,逐级增加,不可跳级,不可相同。
赞(1)
未经允许不得转载:极客笔记 » Markdown 标题
分享到: 更多 (0)

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址