1 | # 目录结构
|
2 |
|
3 | 一个基本的 ydoc 目录结构如下:
|
4 |
|
5 | ```
|
6 | ├── docs/
|
7 | ├── index.jsx
|
8 | ├── NAV.md
|
9 | ├── book-1/
|
10 | ├── index.md
|
11 | └── SUMMARY.md
|
12 | └── book-2/
|
13 | ├── index.md
|
14 | ├── SUMMARY.md
|
15 | ```
|
16 |
|
17 | 以下是他们的功能描述:
|
18 |
|
19 | | 文件 | 描述 |
|
20 | | -------- | ----------- |
|
21 | | `index.jsx` | [首页](pages-index.md) (**必需**) |
|
22 | | `NAV.md` | [导航](nav.md)) (**必需**) |
|
23 | | `book/index.md` | [文档页首页](pages-book.md#页面)] (**必需**) |
|
24 | | `book/SUMMARY.md` | [文档目录](pages-book.md#目录),SUMMARY.md 引用的所有 markdown 文件将会被转换成 html 文件 (__可选__) |
|
25 |
|
26 | > 注:`NAV.md` 和 `SUMMARY.md` 文件名大写
|
27 |
|
28 | ### 静态文件和图片
|
29 |
|
30 | 所有在 docs 目录中且未在 SUMMARY.md 中引用的文件,将会被复制到生成站点的目录中。 |
\ | No newline at end of file |