页面
优质
小牛编辑
134浏览
2023-12-01
首页
执行 init 命令后生产 docs
目录中的 index.jsx
就是首页的文档文件,在这个文件中我们可以通过简单的配置来完善首页信息:
使用 js 定义页面变量的方式不利于阅读,YDoc 参考了开源工具 gray-matter 在页面注入 YAML 方案,使得变量定义变得轻松加愉快
如果你不了解 YAML,可以先查看阮一峰的这篇文章:YAML 语言教程
首页配置如下:
banner 网站标语栏
属性 | 描述 |
---|---|
name | 标语标题 |
desc | 标语描述信息 |
btns | 按钮组,可设置多个按钮 |
caption | 说明信息,例如“当前版本信息” |
btns[n].name | 按钮名称 |
btns[n].href | 按钮链接 |
btns[n].primary | 是否为主按钮 |
features 特性
属性 | 描述 |
---|---|
features[n].name | 特性名称 |
features[n].desc | 特性描述 |
footer 底部信息
属性 | 描述 |
---|---|
copyRight | 版权信息 |
copyRight.name | 版权主体名称 |
copyRight.href | 版权主体链接 |
links | 友情链接 |
links.xxx | 链接组标题 |
links.xxx[n] | 链接项 |
links.xxx[n].name | 链接项名称 |
links.xxx[n].href | 链接项名称 |