typedoc: ts 中目前最好的 api 文档生成工具
[推荐][不推荐] fliegdoc: 更适合 monorepo 的 ts api 文档生成工具
storybook: 跨框架的 ui 组件文档生成器
[推荐][推荐] vuepress: 静态文档网站生成器
很多对比已经在 VuePress 官网上的 为什么不是 里面说明了,吾辈只对比 vuepress 与 docusaurus。
对比 | vuepress | docusaurus |
---|---|---|
优点 | 开发者友好 | 基于 react |
功能非常齐全 | ||
缺点 | 配置还是多了点 | 翻译基于配置而非 markdown |
修改 js 配置无法热更新 | 开发者体验并不是那么友好 | |
文档存在错误,完成度相对更低 |
和 snowpack 一样,基于 react 的解决方案实在不争气。另外,目前 [email protected] 并不支持 pnpm,这是一个已知 bug。