UNPKG

1.25 kBMarkdownView Raw
1
2# 文档页
3
4YDoc 借鉴了 Gitbook 中 `"书"` 的概念：
5
6- YDoc 的每个导航项都是不同的 `"书"`
7- 每本 `"书"` 都是由目录和页面组成
8- YDoc 文档站就是由若干本书及其他页面组成的网站
9
10使用 SUMMARY.md 文件生成一本书的目录，SUMMARY 文件包含了一本书的所有章节信息，具体的文档页面一般是若干 markdown 文件，如果你不知道 markdown 是什么，可以查看本文档中 [markdown 的介绍](/documents/markdown.html)
11
12SUMMARY.md 由一组链接列表组成，将一个列表嵌套到父章节将创建子章节，简单示例如下：
13
14```markdown
15# 目录
16
17### 章节 1
18
19* [快速开始](start.md)
20 * [安装](installation.md)
21* [项目设置](setting.md)
22 * [配置文件](config.md)
23```
24
25##### 锚点
26目录中的章节可以使用锚点指向文件的特定部分。
27
28
29```markdown
30# 目录
31
32### 章节 2
33
34* [API](api.md)
35 * [a](api.md#anchor1)
36 * [b](api.md#anchor2)
37```
38
39##### 章节
40目录可以分为多个部分，如下所示：
41```marsskdown
42# 目录
43
44### 章节 1
45
46* [快速开始](start.md)
47 * [安装](installation.md)
48* [项目设置](setting.md)
49 * [配置文件](config.md)
50
51### 章节 2
52
53* [API](api.md)
54 * [a](api.md#a)
55 * [b](api.md#b)
56
57```
\No newline at end of file