(新手必看系列)关于Markdown标题的使用建议

时间:2024-03-20 13:21:31

标题的使用建议

本文主要介绍标题的书写规范

使用规范

1. 保持间距

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

推荐:

(新手必看系列)关于Markdown标题的使用建议

不推荐:

(新手必看系列)关于Markdown标题的使用建议

2. 多余空格

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

推荐:

(新手必看系列)关于Markdown标题的使用建议

不推荐:

(新手必看系列)关于Markdown标题的使用建议

3. 标点符号

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

推荐:

(新手必看系列)关于Markdown标题的使用建议

不推荐:

(新手必看系列)关于Markdown标题的使用建议

4. 尽量简短

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

推荐:

(新手必看系列)关于Markdown标题的使用建议

不推荐:

(新手必看系列)关于Markdown标题的使用建议

5. 结构推荐

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

(新手必看系列)关于Markdown标题的使用建议
说明如下。

  1. 文档标题:文档的第一个标题应该是一级标题,写在第一行,建议与文件名相同,标题要尽量简短。
  2. 作者:可选,用于声明文档的作者,如果是开源项目的文档,建议把作者名写在修订历史中。
  3. 摘要:用 1~3 句话描述文档的核心内容
  4. 目录:用于快速了解文档的结构,便于导航。
  5. 正文:正文中的标题从二级目录开始,逐级增加,不可跳级,不可相同。

码字不易 感谢点赞支持!