您必须查看的 5 个免费静态文档生成器。

1. Docsify

2. Docusaurus

3. VuePress

4. 板岩

5. Docute

文档是开发的一个重要方面。几乎每个代码库，无论规模大小，都需要某种形式的文档。从一些简单的 README 和贡献指南，到内容丰富的文档，不一而足。然而，在大多数项目中，使用一个优秀且强大的系统来生成、维护和部署文档变得至关重要。这时，“静态文档生成器”就派上用场了。它们易于使用、功能多样且用户友好。它们主要用于记录 API、数据库模式和其他组织的信息。

因此，这里列出了 5 个可以在项目中使用的静态站点生成器。

1. Docsify

网站：https://docsify.js.org
Github Repo：https://github.com/docsifyjs/docsify

特征

• 没有静态构建的 html 文件
• 简单轻量（压缩后约 21kB）
• 智能全文搜索插件
• 多个主题
• 有用的插件 API
• 兼容IE11
• 支持SSR
• 支持嵌入文件

2. Docusaurus

网站：https://docusaurus.io/
Github： https: //github.com/facebook/docusaurus/

特征

• 由 Markdown 提供支持
• 使用 React 构建
• 准备翻译
• 文档版本控制
• 文档搜索
• 快速设置

3. VuePress

网站：https://vuepress.vuejs.org/
Github Repo：https://github.com/vuejs/vuepress

特征

• 最小设置
• 以 Markdown 为中心的项目结构
• 使用 Vue 自定义主题
• 预渲染静态 HTML
• 作为 SPA 运行
• 由 Vue 社区开发和维护

4. 板岩

网站：https://slatedocs.github.io/slate
Github：https://github.com/slatedocs/slate

特征

• 简洁、直观的设计
• 单页文档
• Markdown 支持
• 开箱即用的语法高亮
• 使用多种语言编写代码示例
• 自动、平滑滚动的目录
• 用户可以通过 Github 编辑文档
• RTL 支持

5. Docute

网站：https://docute.org/
Github Repo：https: //github.com/egoist/docute

特征

• 站点即时生成。
• 简洁、优雅的用户界面
• 利用 Markdown 和 Vue 的强大功能。
• 可扩展的插件系统
• 良好的社区支持

你用什么来记录？我知道我肯定漏掉了一些很棒的文档，所以欢迎在下面留言。

** 请注意：此顺序仅供参考，不代表排名。请自行研究，选择最适合您项目的方案。**