文档工具对比

gnn

目前市面上比较常见的工具有如下这些，以首字母排序：

• Gitbook

• Docsify

• Docute

• Docusaurus

• Hexo

• Loppo

• Vuepress

  
  

这些工具我们一一道来。

GitBook

首先不推荐 GitBook，原因是项目已经几年没有维护了，列在此处，仅做对比。

GitBook 的项目地址为 https://github.com/GitbookIO/gitbook
官网为 https://www.gitbook.com/


Docsify
Docsify 的项目地址为 https://github.com/docsifyjs/docsify
官网为 https://docsify.js.org/#/zh-cn/

页面效果如下，有一个封面页和正文页：

Docsify 是一个文档网站生成器，它依赖于 node.js，但不生成静态 html 文件，运行速度快，有很多插件。

环境配置难度低于编译型工具，同时有一个很炫酷的封面页，很好看，支持页内搜索和搜索插件，但它不会生成静态 html 文件，不利于搜索引擎收录，并且对于段落引用不支持，很多文档中的“解释”、“提示”项难以实现。

Docute

不推荐 Docute，原因同样是项目已不再维护。

Docute 项目地址为 https://github.com/egoist/docute，官网已不可访问。


Docusaurus
Docusaurus 项目地址为 https://github.com/facebook/docusaurus
官网为 https://docusaurus.io/zh-CN/

页面效果如下，有一个封面页和正文页：

Docusaurus 可以帮助你在极短时间内搭建漂亮的文档网站。它依赖于 node.js，同时前端框架为 React，也支持 TypeScript，能够开箱即用。

它有着漂亮的首页，支持不同的主题切换，支持页面搜索和搜索插件，支持连续的引用符号 < 生成好看的段落引用，还能为每页生成元数据，利于搜索引擎收录。

Hexo
Hexo 项目地址为 https://github.com/hexojs/hexo

官网为 https://hexo.io/zh-cn/
Hexo 是一个快速、简洁、高效的博客框架，基于 node.js，由于本身只是框架，更多功能还需要主题插件支持，它更适合用作博客网站，而非文档网站。


Loppo
Loppo 项目地址为 https://github.com/ruanyf/loppo
示例网站为 http://redux.ruanyifeng.com/

页面效果如下：

Loppo 是阮一峰大佬的一个项目，目前还比较简单，不推荐用于正式的文档网站。

Vuepress
Vuepress 项目地址为 https://github.com/vuejs/vuepress
官网为 https://vuepress.vuejs.org/zh/

页面效果如下，有一个封面页和正文页：

Vuepress 依赖于 node.js，有很多插件，会进行本地编译，为每个页面生成单独的 html 文件，有利于搜索引擎收录，支持页内搜索和搜索插件，支持段落引用扩展语法 :::tip。

从对比看，常见的这些文档工具都是基于 node.js 构建，区别只在于插件定制化、段落引用、搜索引擎支持等点上。从实际应用及对比来看，推荐优先选择 Docusaurus 和 Vuepress 工具来构建文档网站。

整体对比