Gramax — 使用 Git 的开源 docs-as-code

Gramax：集成 Git 的开源文档即代码平台

对于面临 GitBook 与 GitHub 仓库同步问题的团队来说，Gramax 是一个强大的开源替代方案。该平台将文档存储在 Git Markdown 文件中，确保完全的数据控制，无需依赖云服务。对于涉及敏感数据的项目，这一点至关重要：文件始终保留在您自己的基础设施中。

Gramax 采用文档即代码方法——编辑、通过拉取请求进行变更审批以及发布，都原生在 Git 中完成。可视化编辑器支持以 Markdown 为基础格式，并兼容 Mermaid、PlantUML、Draw.io 和 OpenAPI。

面向开发者的核心功能

Gramax 专为团队协作编写文档而设计：

• 原生 Git 集成：在应用中进行更改，通过 PR 流程，并自动部署到网站。
• AI 搜索与 Copilot：连接本地模型进行语义搜索，并附带来源引用。
• 可视化编辑器：所见即所得界面，支持 Markdown 导出，兼容图表和规范。
• 公共门户：免费自托管文档站点。
• 完全免费：开源，无免费增值模式或用户限制。

支持响应迅速：通过 Telegram 开发者聊天室讨论问题。

逐步设置仓库

连接现有 Git 仓库的步骤：

• 访问 app.gram.ax，选择“上传现有目录”。
• 指定提供商——GitHub、GitLab 或自托管。
• 从您的组织或个人账户中选择一个仓库。
• 上传后，创建一个文档文件夹（例如 /docs）。
• 在目录设置中设置文件夹路径。
• 通过可视化编辑器添加 Markdown 文件。
• 发布更改：云按钮用于 git push，箭头用于 git pull。

可以通过界面回滚更改：查看差异并撤销。同步是双向的——代码编辑器中的编辑会反映在 Gramax 中，反之亦然。建议使用 VS Code 的 Markdown 扩展进行本地工作。

文档即代码实践

与云服务不同，Gramax 消除了锁定风险：所有数据都在您的 Git 中。对于涉及机密数据的 AI 项目，这确保了合规性，无需妥协。中高级开发者团队会欣赏其无供应商锁定和易于迁移的特点。

AI 功能允许设置知识库搜索：模型生成答案，并精确链接到 MD 文件。通过 Mermaid 进行可视化简化了架构文档，OpenAPI 集成则处理 API 规范。

发布到公共站点：配置域名，通过 GitHub Actions 进行 CI/CD，自动部署到 Vercel 或 Netlify。

核心要点

• Gramax 完全开源，无隐藏费用或限制。
• 文档存储在 Git Markdown 中，确保版本控制和监督。
• 支持 AI 搜索，使用本地模型保护隐私。
• 原生 PR 和发布功能，便于团队开发。
• 通过 Telegram 开发者聊天室提供快速支持。

— Editorial Team