文档样例
为统一文档规范,写了这一个文档样例。每个文档标题为一号标题
1 章节标题
每个文档分为几个章节, 章节标题使用二号标题。
1.1 分章节
每个章节可分为一些分章节,分章节标题为三号标题。以此类推。
1.1.1 分章节还可有分章节
标题为四号标题。
1.1.1.1 和分分章节
标题为五号标题。
1.2 章节标号
每一章节,分章节等标题前加上数字标号, 如这一分章节标题前的 1.2
。
1.3 英文标题
英文标题单词首字母大写,下面是一个例子。
1.3.1 English Title
这是一个英文标题的小章节。
2 字体
2.1 字体颜色
正文用普通字体、黑色。 警告字体用 红色 。
警告用 <span style="color:red">红色</span>
或者用 <font color="red">红色</font>font>
2.2 强调内容
强调内容可以用 *倾斜*
- 倾斜、**加黑**
- 加黑、 倾斜加黑
- 倾斜加黑。
3 代码
3.1 行内代码
行内代码由两个反引号括起来, 行内代码
。 行内代码也可以用来表示 强调
。
3.2 代码块
代码块可以由两行三个反引号夹起来。 也可以每一行前都加一个 tab
。
3.3 引用块
引用可以在每行前加一个 >
。
> 这是引用
这是引用。
可以添加 警告、危险警告等。
消息
> **[info] For 消息**
警告
> **[warning] For 警告**
危险警告
> **[danger] For 危险**
成功
> **[success] For 成功消息**
消息
[info] 消息
警告
[warning] 警告
危险警告
[danger] 危险
成功
[success] 成功消息
4 列表
有序列表
用来表示步骤等,无序列表
用来表示枚举等。
4.1 有序列表
把大象装进冰箱分几步:
- 把冰箱门打开
- 把大象塞进去
- 把冰箱门关上
4.2 无序列表
无序列表有两种表示方式。
4.2.1 无序列表 1
一种是用 -
表示。 下面的都是水果
- 苹果
- 橘子
- 香蕉
4.2.2 无序列表 2
一种是用 *
表示。 下面的都动物
- 猫
- 狗
- 鸡
- 鸭
5 目录
每个文档要有目录,可在文档标题后面加上下面一句, 就可以加上目录了。
<!-- toc -->
6 中英文版本
6.1 中英互换
文档顶部有 中文|English
链接。点击后会中英版本互换。
6.2 图片复用
中英版本分别在 en
、zh
两个目录下,图片可以通过相对路径方式进行复用。
这是中文版本下的一个图片
![chinese](./chinese.png)
这是英文版本下的一个图片,放在中文版本下面
![english](../../../zh/path/to/chinese.png)