Gramax — open-source docs-as-code with Git

Gramax: Open-Source Docs-as-Code Platform with Git Integration

Teams facing GitBook sync issues with GitHub repositories find Gramax to be a robust open-source alternative. The platform stores documentation in Git Markdown files, ensuring full data control without cloud restrictions. For projects with sensitive data, this is critical: files remain in your own infrastructure.

Gramax implements a docs-as-code approach—editing, change approval via pull requests, and publishing happen natively in Git. Visual editor support maintains Markdown as the base format, adding compatibility with Mermaid, PlantUML, Draw.io, and OpenAPI.

Key Features for Developers

Gramax is designed for team collaboration on documentation:

• Native Git Integration: Changes are made in the app, go through PRs, and are automatically deployed to the site.
• AI Search and Copilot: Connect local models for semantic search with citations from sources.
• Visual Editor: WYSIWYG interface with Markdown export, supporting diagrams and specifications.
• Public Portal: Self-host documentation sites at no cost.
• Completely Free: Open-source with no freemium models or user limits.

Support is responsive: a developer chat on Telegram for discussing issues.

Repository Setup Step by Step

To connect an existing Git repository:

• Go to app.gram.ax and select "Upload Existing Directory."
• Specify the provider—GitHub, GitLab, or self-hosted.
• Choose a repository from your organization or personal account.
• After uploading, create a folder for docs (e.g., /docs).
• Set the folder path in the catalog settings.
• Add a Markdown file via the visual editor.
• Publish changes: cloud button for git push, arrows for git pull.

Reverting changes is possible through the interface: view the diff and roll back. Sync is bidirectional—edits in the code editor reflect in Gramax, and vice versa. A Markdown extension for VS Code is recommended for local work.

Docs-as-Code in Practice

Unlike cloud services, Gramax eliminates lockout risks: all data is in your Git. For AI projects with confidential data, this ensures compliance without compromises. Mid- to senior-level developer teams will appreciate the lack of vendor lock-in and ease of migration.

AI features allow setting up knowledge base search: the model generates answers with precise links to MD files. Visualization via Mermaid simplifies architecture documentation, and OpenAPI integration handles API specs.

Publishing to a public site: configure a domain, CI/CD via GitHub Actions for auto-deploy to Vercel or Netlify.

Key Takeaways

• Gramax is fully open-source, with no hidden fees or limits.
• Docs are stored in Git Markdown, ensuring version control and oversight.
• AI search support with local models for privacy.
• Native PRs and publishing for team development.
• Fast support via the developer Telegram chat.

— Editorial Team