说明
团队统一遵循约定的 Markdown 编写规范,目的是提高文档的可读性,降低团队成员之间的沟通成本。
规则
通用
- 后缀必须使用
.md
- 文件名必须使用小写,多个单词之间使用
-
分隔 - 文件编码必须用
UTF-8
- 章节标题必须以
##
开始,而不是#
- 章节标题和内容间必须有一个空行
空格
- 中文与英文、数字及
@ # $ % ^ & * . ( )
等符号之间需要加空格 - 数字与单位之间需要加空格
- 链接前后需要加空格
- 中文标点与前后字符之间不需要加空格
° / %
与数字之间不需要增加空格
中文符号
- 如果括号内有中文,则使用中文括号
- 如果括号中的内容全部都是英文,则使用半角英文括号
- 简体中文使用直角引号(「」)代替双引号(“”)
- 省略号使用「……」,而「。。。」仅用于表示停顿
- 专有名词使用正确的大小写,如
GitHub