66 lines
1.2 KiB
Markdown
66 lines
1.2 KiB
Markdown
|
# 文档格式规范
|
|||
|
|
|
|||
|
|
## 标题相关
|
|||
|
|
|
|||
|
|
一篇文档内，以 `##` 为一类目开始，根据内容层级安排，逐层增加。后续可使用 `###` 和 `####` 标记。
|
|||
|
|
|
|||
|
|
文档内容层级最多为三级，如果超过三级则考虑调整文件内容。
|
|||
|
|
|
|||
|
|
> `#####` 与 `######` 两个标记不得使用。
|
|||
|
|
|
|||
|
|
## 正文内容
|
|||
|
|
|
|||
|
|
### 粗体的使用
|
|||
|
|
|
|||
|
|
禁止使用粗体。
|
|||
|
|
|
|||
|
|
### 斜体的使用
|
|||
|
|
|
|||
|
|
禁止使用斜体。
|
|||
|
|
|
|||
|
|
### 关于链接
|
|||
|
|
|
|||
|
|
链接内容应为目标网页标题或可表达主题的文字，禁止直接使用网址。
|
|||
|
|
|
|||
|
|
如：
|
|||
|
|
|
|||
|
|
正确：[A闪的博客](ashan.org)
|
|||
|
|
|
|||
|
|
错误：[ashan.org](ashan.org)
|
|||
|
|
|
|||
|
|
### 关于列表
|
|||
|
|
|
|||
|
|
如果表达类似操作步骤带有顺序的内容，请使用数字列表，且markdown数字标题均为“1”。
|
|||
|
|
|
|||
|
|
1. 打开IDE
|
|||
|
|
1. 创建新项目
|
|||
|
|
1. 编译测试项目
|
|||
|
|
|
|||
|
|
如果列表内容为平级内容，则使用点状列表
|
|||
|
|
|
|||
|
|
- Egret Engine 2D
|
|||
|
|
- Egret Engine 3D
|
|||
|
|
- Egret Wing
|
|||
|
|
|
|||
|
|
### 关于注意事项
|
|||
|
|
|
|||
|
|
注意事项使用块。
|
|||
|
|
|
|||
|
|
> 这是注意事项内容。
|
|||
|
|
|
|||
|
|
### 关于代码
|
|||
|
|
|
|||
|
|
正文中出现的代码使用单引号包裹。
|
|||
|
|
|
|||
|
|
### 关于表格
|
|||
|
|
|
|||
|
|
如正文中可使用表格形式表达，尽量使用表格方式，更加清晰，利于理解。
|
|||
|
|
|
|||
|
|
表格内容应左对齐。
|
|||
|
|
|
|||
|
|
### 关于图片
|
|||
|
|
|
|||
|
|
图片显示上下应各空一行。
|
|||
|
|
|
|||
|
|
|