gramax

Gram-axGPL-3.0活跃维护

自托管的文档协作平台，用所见即所得编辑器直接编辑 Git 仓库里的 Markdown，替代 GitBook 和 Confluence，适合团队做 docs-as-code 知识库。

Open-source, self-hosted GitBook & Confluence alternative: a WYSIWYG editor over Markdown in your own Git repo, with a documentation portal

暂无版本621star28fork同步于 2026-11-07 07:33 UTC

文档协作所见即所得 Markdown 编辑器自托管知识库

对比 GitHub 官网 confluence-alternative docs-as-code documentation-tool git gitbook-alternative

怎么上手

由 README 提炼，执行前请确认

原文

npm install -g cli
cli build --source ./content --destination ./output

硬件要求按 README 说明

README 未说明硬件要求；编辑器提供 Windows、Mac、Linux 桌面版和网页版，文档门户可用 Docker 或静态站点方式部署。

下载：源码 zip·GitHub Releases（安装包）本站不镜像安装包

项目说明

由 README 自动翻译提炼

没人工点评？写下你的经验

自托管文档平台，用可视化编辑器在自有 Git 仓库里写 Markdown 并发布文档门户

自托管的文档协作平台，用所见即所得编辑器直接编辑 Git 仓库里的 Markdown，替代 GitBook 和 Confluence，适合团队做 docs-as-code 知识库。

核心能力

可视化编辑 Markdown，非技术用户也能上手
文档以本地 Markdown 文件存储，可用任意编辑器修改
对接 GitHub、GitLab、Bitbucket、Gitea 等 Git 仓库做版本控制
支持标签页、表格、视频、Mermaid/Excalidraw 图表和 Swagger 描述
可将目录发布为可定制的文档门户网站

容易踩的坑

文档门户的 Docker 部署需自行从 gram.ax/docker-compose.yaml 获取编排文件；静态站点构建依赖全局安装的 cli 包；编辑器可直接用网页版 app.gram.ax 或从官网下载桌面版，无需本地编译。

内容由模型根据 README 生成，可能不完整或不准确，以官方文档为准。看原文 README

用户点评

登录用户的真实使用记录，可按版本和硬件筛选

共 0 条

还没有人点评。第一个说出真实体验的人最有价值。

README 原文

未翻译

在 GitHub 打开

Gramax is a free, open-source application for creating, editing, and publishing docs as code. It stores all data locally in Markdown format, offering flexibility and offline access, and seamlessly integrates with Git for version control and collaboration. Whether you need a product documentation portal, an internal knowledge base, project documentation, or personal notes, Gramax is a versatile solution.

Looking for an alternative to GitBook, Mintlify, or typical Static Site Generators (SSGs)?
Gramax provides a powerful, Markdown-based approach that combines an intuitive visual editor with robust Git integration.

Features

Visual Editor: Makes editing Markdown-files easy for technical and non-technical users.
Cross-Platform: Available as a desktop app (Windows, Mac, Linux) and a web-based version.
Local Storage: Files are stored locally in Markdown, editable in any text editor.
Customizable Styles: Personalize the app and documentation portal appearance.
Multilingual Support: Create documentation in 17 languages, including English, Spanish, and more.
Advanced Editing: Supports tabs, tables, video embedding, code blocks, diagrams (Mermaid, Excalidraw, Diagrams.net), and Swagger API descriptions.
Git Integration: Connect to Git repositories (GitHub, GitLab, Bitbucket, Gitea, etc.) for version control and collaboration.
Documentation Portal: Publish catalogs to a dedicated, customizable website.
Migration Support: Import from Confluence and Notion with preserved formatting and hierarchy.

Installation

Editor app

Access it at app.gram.ax.
Download the app for your OS from gram.ax.

Usage

Create a Catalog: Add a catalog within a workspace to store articles.
Edit Articles: Use the Markdown editor with features like tabs, tables, and multimedia.
Connect to Git: Link your catalog to a Git repository for collaboration.
Synchronize Changes: Pull and push updates via built-in Git commands, resolving conflicts as needed.
Publish: Share your catalog to the documentation portal.

For more details, see the official documentation.

Documentation Portal

Publish your documentation as a website, hosted on your server or as a static site.

Setup

Docker: Deploy with docker-compose.yaml from gram.ax/docker-compose.yaml.
Static Site:
1. npm install -g cli.
2. cli build --source ./content --destination ./output.

See Setting Up the Documentation Portal for instructions.

Contact

For support or questions, email [email protected], join our community chat in Telegram or visit our GitHub issues page.