| 1 | # 页面
|
| 2 |
|
| 3 | ## 首页
|
| 4 |
|
| 5 | 执行 init 命令后生产 `docs` 目录中的 `index.jsx` 就是首页的文档文件，在这个文件中我们可以通过简单的配置来完善首页信息：
|
| 6 |
|
| 7 | > 使用 js 定义页面变量的方式不利于阅读，YDoc 参考了开源工具 [gray-matter](https://github.com/jonschlinkert/gray-matter) 在页面注入 YAML 方案，使得变量定义变得轻松加愉快 😜
|
| 8 |
|
| 9 | 如果你不了解 YAML，可以先查看阮一峰的这篇文章：[YAML 语言教程](http://www.ruanyifeng.com/blog/2016/07/yaml.html)
|
| 10 |
|
| 11 | 首页配置如下：
|
| 12 |
|
| 13 | ### banner 网站标语栏
|
| 14 |
|
| 15 | | 属性 | 描述 |
|
| 16 | | ---- | ----------- |
|
| 17 | | `name` | 标语标题 |
|
| 18 | | `desc` | 标语描述信息 |
|
| 19 | | `btns` | 按钮组，可设置多个按钮 |
|
| 20 | | `caption` | 说明信息，例如“当前版本信息” |
|
| 21 | | `btns[n].name` | 按钮名称 |
|
| 22 | | `btns[n].href` | 按钮链接 |
|
| 23 | | `btns[n].primary` | 是否为主按钮 |
|
| 24 |
|
| 25 | ### features 特性
|
| 26 | | 属性 | 描述 |
|
| 27 | | ---- | ----------- |
|
| 28 | | `features[n].name` | 特性名称 |
|
| 29 | | `features[n].desc` | 特性描述 |
|
| 30 |
|
| 31 | ### footer 底部信息
|
| 32 | | 属性 | 描述 |
|
| 33 | | ---- | ----------- |
|
| 34 | | `copyRight` | 版权信息 |
|
| 35 | | `copyRight.name` | 版权主体名称 |
|
| 36 | | `copyRight.href` | 版权主体链接 |
|
| 37 | | `links` | 友情链接 |
|
| 38 | | `links.xxx` | 链接组标题 |
|
| 39 | | `links.xxx[n]` | 链接项 |
|
| 40 | | `links.xxx[n].name` | 链接项名称 |
|
| 41 | | `links.xxx[n].href` | 链接项名称 |
|
| 42 |
|