Skip to content

wwsheng009/yao-docs

Repository files navigation

记录Yao应用开发过程中的一些问题与经验

收集的一些与 Yao 开发相关的文档,文档使用vitepress制作,并自动发布到github page上。直接访问地址:

https://wwsheng009.github.io/yao-docs

cf pages 地址: https://yao-docs.wwsheng.cloud

文档编写与构建

文档使用markdown格式编写,新建的文档存放在目录/docs

在文档发布之前先本地构建一次检查有没有错误。

pnpm run build

vitepress配置文件自动生成

vitepress以下配置文件使用脚本生成

  • /docs/.vitepress/sidebar.ts使用脚本script/generate_config.ts根据目录结构自动生成。
  • /docs/.vitepress/nav.ts使用脚本script/generate_config.ts根据目录结构自动生成。

监听文件变更,自动生成vitepress配置文件

node script/watch.ts

index.md文件的更新

当一个目录中新增/修改/删除文件后,索引文件index.md并不会自动的更新。

重建所有的index.md文件

pnpm run build:index