省流版：
demo地址：github.com/ZHAISHENKIN…
背景
新项目 vue3 + vite + ts，想给项目的工具方法根据注释生成 api 文档，再利用静态站点生成器把文档美化。尝试各种组合，最终敲定工具栈：typedoc + vitepress。
正文
原理比较简单，
- 用 typedoc 插件
typedoc-plugin-markdown将输出文档转为markdown 格式（为了更好的适配 vitepress）， - 用 typedoc.js 脚本将 typedoc 映射的 JSON 作为 sidebar，
- 用 github page 部署文档，将 build 的 dist 文件夹 push 到 github
- 脚本 deploy.sh 一键部署
环境
nodejs v14.21.2
npm 6.14.17
不足：
typedoc 生成的文档不支持中文，一些改关键字的插件和 markdown 插件会冲突
参考链接：
文档网站生成器 — VitePress框架: zhuanlan.zhihu.com/p/453775525
使用 TypeDoc 自动为 TypeScript 项目生成 API 文档 zhuanlan.zhihu.com/p/577159570
应用级别配置： 基础 | VitePress中文网 vitejs.cn/vitepress/c…
TypeDoc Example www.typedoc.cn/example/
Front-matter hexo.io/zh-cn/docs/…
