Doctave

Doctave 是一个文档平台，结合了使用 Markdown 编写的灵活性与专业文档托管的强大功能。您可以将文档以纯文本文件的形式编写，存储在与代码同一的 Git 仓库中，Doctave 会帮您将其转换成美观且可搜索的文档网站。

该平台支持常规的 Markdown 指南和用于 API 文档的 OpenAPI 规范。当您进行更改时，它会自动创建预览环境，方便团队在发布前审查更新。所有内容都保存在您的 Git 仓库中，让您对文档拥有完整的版本控制。

Doctave Studio 是配套的桌面应用程序，提供实时预览、自动补全建议、断链检查和拼写检查。这些工具共同帮助团队创建保持最新且准确的文档。

开始使用 Doctave 非常简单。以下是有效使用它的方法：

• 在您的代码仓库中创建一个文档文件夹，并使用 Markdown 文件编写内容。包含一个 README.md 文件作为起始页面。

• 在您的电脑上安装 Doctave Studio，以便在本地预览文档，并在编写时实时更新。

• 设置您的 doctave.yml 配置文件，以定义文档结构、主题颜色和导航链接。

• 通过 Doctave 平台将您的 Git 仓库连接到 Doctave。每次推送更改时，Doctave 会自动更新已发布的文档。

• 对于 API 文档，将您的 OpenAPI 规范文件添加到仓库中。Doctave 会自动生成交互式 API 参考页面。

• 使用 Git 分支管理不同版本的文档。创建拉取请求以在发布前审查更改，Doctave 会为每个拉取请求生成预览链接。

• 基于Git的文档工作流，支持版本控制

• Doctave Studio桌面编辑器，实时预览

• 支持OpenAPI规范的API文档

• 为拉取请求自动生成预览环境

• 多版本文档管理

• 内置全内容搜索

• 自定义品牌和主题选项

• 读者分析和反馈收集

• CI/CD集成，实现自动部署

• 密码保护的文档选项