高端大气的在线文档

背景

• 产品介绍，帮助手册，操作手册，开发说明，个人的简单网站等等，都需要一个在线的文档，特别是开源社区的在线文档也非常需要，开源社区也为此提供了大量的工具。
• 如何找到一款高端大气的，能够自己部署的，markdown格式构建的产品呢？

市面产品

• 有很多直接就能用的，比如阿里在线文档，语雀等，还可以，就是不能私有部署，也不够风骚。

Docusaurus

• Docusaurus 是 Facebook 专门为开源项目开发者提供的一款易于维护的静态网站创建工具，使用 Markdown 即可更新网站。构建一个带有主页、文档、API、帮助以及博客页面的静态网站，只需5分钟。
• Docusaurus 是一个静态站点生成器。它构建了一个具有快速客户端导航的单页应用程序，利用React的全部功能使您的站点具有交互性。它提供开箱即用的文档功能，但可用于创建任何类型的网站（个人网站、产品、博客、营销登录页面等）。

Docsify

• Docsify 是一个动态生成文档网站的工具。不同于 VuePress、GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行。这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 .html 文件“污染” commit 记录，只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages 。

其它

• VuePress、Hexo、Jelly 和 GitBook 等。

鸡毛掸子

• 调查了一圈，都不够劲爆，不够靓丽，还有我个人一个需求，就是左边是总体目录，右边应该是文章结构。于是整了一个，效果如下：

下一步

当然，还有很多问题需要解决：比如左边还不能三四级，search需要全文搜索（第一方案借助第三方，如果没有办法自行构建）。

本周能整一个beta版，会发布到gitee上，大家一起改进