gramax

机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

Gramax 是一个免费的开源应用程序，用于创建、编辑和发布以代码形式的文档。它将所有数据本地存储为 Markdown 格式，提供灵活性和离线访问，并与 Git 无缝集成以进行版本控制和协作。无论您需要产品文档门户、内部知识库、项目文档还是个人笔记，Gramax 都是一个多功能的解决方案。

正在寻找 GitBook、Mintlify 或典型静态网站生成器 (SSGs) 的替代方案？ Gramax 提供了一种强大的基于 Markdown 的方法，将直观的可视化编辑器与强大的 Git 集成结合起来。

功能

• 可视化编辑器：让技术和非技术用户都能轻松编辑 Markdown 文件。

• 跨平台：可作为桌面应用程序（Windows、Mac、Linux）以及基于网页的版本使用。

• 本地存储：文件以 Markdown 格式本地存储，可在任何文本编辑器中编辑。

• 可定制样式：个性化应用程序和文档门户的外观。

• 多语言支持：可创建 17 种语言的文档，包括英语、西班牙语等。

• 高级编辑功能：支持标签页、表格、视频嵌入、代码块、图表（Mermaid、Excalidraw、Diagrams.net）和 Swagger API 描述。

• Git 集成：连接到 Git 仓库（GitHub、GitLab、Bitbucket、Gitea 等）进行版本控制和协作。

• 文档门户：将目录发布到专用的、可自定义的网站。

• 迁移支持：从 Confluence 和 Notion 导入，同时保留格式和层级。

安装

编辑器应用

• 在 app.gram.ax 访问它。

• 从 gram.ax 下载适用于您的操作系统的应用。

使用

1. 创建目录：在工作区内添加目录以存储文章。

2. 编辑文章：使用带有选项卡、表格和多媒体功能的Markdown编辑器。

3. 连接到Git：将您的目录链接到Git仓库以进行协作。

4. 同步更改：通过内置Git命令拉取和推送更新，并根据需要解决冲突。

5. 发布：将您的目录分享到文档门户。

有关更多详细信息，请参阅官方文档。

文档门户

将您的文档发布为网站，可以托管在您的服务器上，也可以作为静态网站发布。

设置

• Docker：使用 gram.ax/docker-compose.yaml 中的 docker-compose.yaml 进行部署。

• 静态网站：

  1. npm install -g cli.

  2. cli build --source ./content --destination ./output.

有关说明，请参见 设置文档门户。

联系我们

如需支持或有任何问题，请发送电子邮件至 info@gram.ax ，加入我们的 Telegram 社区聊天，或访问我们的 GitHub 问题页面。