文档站 建站框架介绍

同博客框架 WordPress、Hexo 等一样，Web 文档也有自己的框架，如比如 Java 的 Javadoc，Python 的 pydoc，以及Python-sphinx。对于 Python 有专门文档标记语言 reStructuredText（RST），常见的 Python 各种库和工具的帮助文档基本都是用 RST 所写。如 Requests、Flask、Scrapy 等。

不过，用 RST 编写对于已经会了 Markdown（更为流行） 的读者来说，有点浪费，而且两者的语法差异较大，容易造成记忆冲突。下面介绍几种可以直接支持 markdown 语法的框架。

Docusaurus

• 官方地址：https://docusaurus.io/

Docusaurus 是 Facebook 专门为开源项目开发者提供的一款易于维护的静态网站创建工具，使用 Markdown 即可更新网站。构建一个带有主页、文档、API、帮助以及博客页面的静态网站，只需5分钟。

Docusaurus 是一个静态站点生成器。它构建了一个具有快速客户端导航的单页应用程序，利用React的全部功能使您的站点具有交互性。它提供开箱即用的文档功能，但可用于创建任何类型的网站（个人网站、产品、博客、营销登录页面等）

• https://ionicframework.com/docs/intro/cli

MkDocs

• 官方地址：https://www.mkdocs.org/
• 主题地址：https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes

MkDocs 是一个流行的Python静态站点生成器，其价值主张类似于Docusaurus。如果你不需要单页应用，也不打算利用 React 的话，这是个好选择。Python 很多库的帮助文档都是使用这个框架生成的。

Material for MkDocs 是一个优秀的主题。

sphinx

• 官方地址：https://www.osgeo.cn/sphinx/index.html
• 主题地址：https://sphinx-themes.org/

Sphinx是Python文档生成器，它基于reStructuredText标记语言，可自动根据项目生成HTML，PDF等格式的文档，无数著名项目的文档均用Sphinx生成，如机器学习库scikit-learn、交互式神器Jupyter Notebook

sphinx是一种基于Python的文档工具，它可以令人轻松的撰写出清晰且优美的文档，由Georg Brandl在BSD许可证下开发。新版的Python3文档就是由sphinx生成的，并且它已成为Python项目首选的文档工具，同时它对C/C++项目也有很好的支持。更多详细特性请参考spinx官方文档

Teadocs

Teadocs 是一款能够帮你快速构建html文档的工具，它基于nodejs编写，并使用markdown来编写文档内容。

Teadocs 提供内置的搜索技术，除了编写好你引以为豪的内容以外，你无需关注的任何额外的技术问题。

你可以使用它来编写开源书籍、API文档学习、笔记、学习心得、甚至可以用来写博客。

VuePress

• 官方地址：https://vuepress.vuejs.org/

VuePress 与 Docusaurus 有很多相似之处——两者都非常专注于以内容为中心的网站，并提供开箱即用的定制文档功能。但是，VuePress 是 Vue 驱动的，而 Docusaurus 则是 React 驱动的。 如果你想要一个基于 Vue 的解决方案，VuePress 是个不错的选择。

Docsify

• 官方地址：https://docsify.js.org/#/zh-cn/

docsify 是一个超级好用的文档站点生成器！特点是使用简单，跟着官网教程输入两行命令就能完成安装和生成站点了，生成的文档样式也很精简优雅，并且是响应式的，手机上看也很不错。

docsify 使创建文档网站变得容易，但它不是一个静态的网站生成器，并且对 SEO 不友好。

GitBook

• 官方地址：https://www.gitbook.com/
• git 地址：https://github.com/GitbookIO/gitbook

GitBook 具有非常干净的设计，已被许多开源项目使用。但随着它把重点逐渐从开源工具转向商业产品，它不再符合开源项目文档网站的需要。结果就是，许多项目转用了其他产品。你可能会读到关于 Redux 转向 Docusaurus 的消息 here.

目前，GitBook 只对开源和非营利团队免费。Docusaurus 则对所有人免费。

Jekyll

• 官方地址：https://github.com/jekyll/jekyll

是世界上最成熟的静态网站生成器之一，也是一个很好的使用工具-事实上，在Docusaurus之前，Facebook的大多数开源网站都是基于Jekyll！ 它的上手难度极低。 在静态网站构建方面，我们想要为你带来和 Jekyll 类似的开发者体验。

与静态生成的 HTML 和使用 ＜script/＞ 标签添加的交互性相比，Docusaurus 网站是 React 应用程序。我们希望借由现代化 JavaScript 生态系统工具，在文档站点性能、资源构建系统，优化和易部署性等领域制定新标准。

Dumi

• 官方地址：https://d.umijs.org/zh-CN

阿里推出的文档站点生成工具，也是输入几行命令就能得到文档网站。和 docsify 不同的是，Dumi 专为 组件开发 场景而生，很适合作为组件库的文档。可以嵌入和折叠代码块、提供组件在终端中的浏览效果等，Dumi 生成的网站很精简，而且封面支持自定义特性的展示，因此也很适合作为项目或产品的官方文档。

Gatsby

• 官方地址：https://www.gatsbyjs.com/

Gatsby 包含了许多功能，拥有丰富的插件生态系统，能够做 Docusaurus 所做的一切。当然，这带来了较陡的学习曲线。 Gatsby 在许多方面做得都很出色，适合构建许多类型的网站。另一方面，Docusaurus 力图将一件事做到尽善尽美——成为最好的内容撰写与发布工具。

GraphQL 是 Gatsby 的核心，但搭建 Gatsby 网站不一定要用到它。 而在大多数静态网站中，你更不需要 GraphQL 所提供的灵活性。

Docusaurus 2 的许多方面都被 Gatsby 的出色之处所启发，这是一个优秀的替代品。

Docz 是 Gatsby 建立文档网站的主题。 它的功能与 Docusaurus 相比要匮乏。

Next.js

• 官方地址：https://nextjs.org/

Next.js 是另一个非常流行的混合 React 框架。它可以帮助你构建出色的文档网站，但它并不着重于文档功能本身，而且需要你手动实现 Docusaurus 所自带的功能。

Nextra 是一个在 Next.js 之上构建的固执己见的静态站点生成器。它的功能与 Docusaurus 相比要匮乏。