| 1 | # 配置
|
| 2 | Ydoc 允许你使用灵活的配置来自定义站点，这些配置项被指定到 ydoc.json 或 ydoc.js 文件，目录结构如下：
|
| 3 |
|
| 4 | ```
|
| 5 | ├── ydoc.json
|
| 6 | ├── docs/
|
| 7 |
|
| 8 | ```
|
| 9 |
|
| 10 | 在 docs 上级目录创建 ydoc.json，如果没有配置文件，ydoc 将使用默认的配置。
|
| 11 |
|
| 12 |
|
| 13 | ## 配置项
|
| 14 |
|
| 15 | | 变量 | 类型 | 默认值 | 描述 |
|
| 16 | | -------- | --- |-----| ----------- |
|
| 17 | | `root` | String | docs | 文档目录 |
|
| 18 | | `title` | String | ydoc | 网站标题 |
|
| 19 | | `keywords` | String| ydoc | 网站关键字 |
|
| 20 | | `author` | String| ymfe | 网站作者 |
|
| 21 | | `description` | String| ydoc | 网站描述 |
|
| 22 | | `dist` | String| _site | 网站生成路径 |
|
| 23 | | `plugins` | Array | [] | 插件列表
|
| 24 | | `pluginsConfig` | Object | null | 插件配置
|
| 25 |
|
| 26 |
|
| 27 | ### plugins 配置示例
|
| 28 |
|
| 29 | ```json
|
| 30 | {
|
| 31 | "plugins": ["demo"],
|
| 32 | "pluginsConfig": {
|
| 33 | "demo": {
|
| 34 | "title": "demo"
|
| 35 | }
|
| 36 | }
|
| 37 | }
|
| 38 | ```
|
| 39 | 上面的配置含义是加载了插件 demo, 并且给 demo 插件设置了配置项:
|
| 40 |
|
| 41 | ```json
|
| 42 | {
|
| 43 | "title" : "demo"
|
| 44 | }
|
| 45 | ```
|