收集的一些与 Yao 开发相关的文档,文档使用vitepress
制作,并自动发布到github page
上。直接访问地址:
https://wwsheng009.github.io/yao-docs
文档使用markdown
格式编写。存放目录/docs
。
在文档发布之前先本地构建一次检查有没有错误。
pnpm run build
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
文件
pnpm run build:index