Update： 2022-08-05
| 名称 | 网址 | star | 优点 | 缺点 | |
|---|---|---|---|---|---|
| ❌ | gitbook | https://www.gitbook.com/ | 24.8 | - 多人协作的文档平台，适合编写文档以及内部知识库 - 全文搜索 - 可以同步到github - 具有版本控制功能 |
- 不能使用Vue组件 - 访问慢 |
| ❌ | StoryBook | https://storybook.js.org/ | 71.6k | - 分开展示各个组件不同属性下的状态 - 该工具适用于react、vue、angualar等 - 能追踪组件的行为并且具有属性调试功能 - 可以为组件自动生成文档和属性列表 |
- 英文文档 - 界面不好看 - 配置复杂 - 仅支持组件文档，不支持其他文档 |
| ⚠ | docsify | https://docsify.js.org/#/zh-cn/ | 20.9k | - 无需构建过程。不会将md文档预先编译为静态html，在网站运行的时候才会将md动态转换从html - 支持全文搜索 - 配置简单，不需要安装太多的依赖 |
- 运行时构建，不利于SEO - 不能适配Vue单文件 |
| ❌ | Dumi | https://d.umijs.org/zh-CN | 2.3k | 📦 开箱即用，将注意力集中在组件开发和文档编写上 📋 丰富的 Markdown 扩展，不止于渲染组件 demo 🏷 基于 TypeScript 类型定义，自动生成组件 API 🎨 主题轻松自定义，还可创建自己的 Markdown 组件 📱 支持移动端组件库研发，内置移动端高清渲染方案 📡 一行命令将组件资产数据化，与下游生产力工具串联 |
基于React的，写法上使用jsx的方式，暂不支持Vue等框架 |
| ❌ | Docz | https://www.docz.site/ | 22.7k | 基于MDX进行了封装 完全使用Gatsby构建，可以使用Gatsby的插件和工具生态 零配置 支持TypeScript、CSS预处理器 内置Playground组件，编辑组件可以进行实时渲染 内置Props组件，注释直接生成文档 |
英文文档 基于React |
| ✅ | vuepress | https://v1.vuepress.vuejs.org/zh/ | 20.4k | - 有较好的加载性能和SEO - 支持按需加载，支持自定义主题。 - 可以直接在 Markdown 文件中使用Vue组件，包括单文件组件 |
- VuePress默认只支持搜索标题，全文搜索需要引入三方工具。 - 编译过程比较慢，使用webpack编译 - 不支持vue3 |
| ✅ | vuepress-next | https://v2.vuepress.vuejs.org/zh/ | 1.2k | - 支持Vue3组件 - 使用vite编译，速度更快 - 动画效果更好，界面更美观 |
- 配置与vuepress1有区别 - 使用第三方组件，需要第三方组件在npm仓库中 - 组件的显示和代码需要写两份（暂时，https://www.cjsound.cn/vuepress2-plugin/） |
| ⚠ | vitepress | https://vitejs.cn/vitepress/ | 4.6k | VitePress 是 VuePress 的孪生兄弟，它同样由 Vue.js 团队创建和维护。 VitePress 甚至比 VuePress 要更轻更快 | 它在灵活性和可配置性上作出了一些让步，比如它不支持插件系统。 |
| ❌ | bisheng | 2.7k | 一个把 Markdown 转为 React 单页网站的工具。 | 基于React | |
| ❌ | Vue Styleguidist | 2.2k | 自动生成组件文档 | 不能编写除组件之外的文档 | |
| ❌ | vuese | 1.5k | 自动生成组件文档 | 不能编写除组件之外的文档 | |
| ❌ | Docusaurus | 34k | Facebook开源的文档搭建网站 | 基于React技术栈 | |
| ❌ | Nuxt | 40.7k | Vue SSR 框架 | 主要用于构建应用程序，二次开发工作量较大，部署也麻烦 |