你必须查看的5个免费的静态文档生成工具

原始地址：https://dev.to/nafis/5-free-static-documentation-generators-you-must-check-out-5ged

‘’’
文档是开发的重要方面。几乎每个代码库，无论大小，都需要某种形式的文档。从一些简单的README文件和贡献指南到全面的文件。然而，在大多数项目中，使用一个好用、强大和易于部署文档的系统变得必要。这就是所谓的"静态文档生成器"派上用场的地方。它们易于使用、多功能且极其用户友好。它们主要被组织机构用于文档化API、数据库模式和其他信息。所以，这里有一个你可以在项目中使用的静态站点生成器的列表。

[Docsify]

1. Docsify
   网站：
   https://docsify.js.org
   Github仓库：
   https://github.com/docsifyjs/docsify

[功能]
功能

• 没有静态生成的html文件
• 简单轻量（gzipped大小约为21kB）
• 智能全文搜索插件
• 多个主题
• 实用的插件API
• 兼容IE11
• 支持SSR
• 支持嵌入文件

[Docusaurus]
2. Docusaurus
网站：
https://docusaurus.io/
Github：
https://github.com/facebook/docusaurus/

[功能]
功能

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

[VuePress]
3. VuePress
网站：
https://vuepress.vuejs.org/
Github仓库：
https://github.com/vuejs/vuepress

[功能]
功能

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

[Slate]
4. Slate
网站：
https://slatedocs.github.io/slate
Github：
https://github.com/slatedocs/slate

[功能]
功能

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

[Docute]
5. Docute
网站：
https://docute.org/
Github仓库：
https://github.com/egoist/docute

[功能]
功能

• 实时生成网站
• 简洁优雅的用户界面
• 充分利用Markdown和Vue的功能
• 可扩展的插件系统
• 有良好的社区支持

你使用什么文档工具？我知道还有一些很棒的工具我没有列出来，所以请在下方评论区提问。

请注意：排序只是随意的，并不代表排名。在选择最适合您项目的工具之前，请做好自己的调查研究。
‘’’