Gramax — Open-Source docs-as-code mit Git

Gramax: Open-Source Docs-as-Code-Plattform mit Git-Integration

Teams, die Probleme mit der GitBook-Synchronisation mit GitHub-Repositories haben, finden in Gramax eine robuste Open-Source-Alternative. Die Plattform speichert Dokumentation in Git-Markdown-Dateien und gewährleistet so volle Datenkontrolle ohne Cloud-Beschränkungen. Für Projekte mit sensiblen Daten ist dies entscheidend: Dateien verbleiben in Ihrer eigenen Infrastruktur.

Gramax setzt einen Docs-as-Code-Ansatz um – Bearbeitung, Änderungsfreigabe über Pull Requests und Veröffentlichung erfolgen nativ in Git. Die Unterstützung eines visuellen Editors behält Markdown als Basisformat bei und fügt Kompatibilität mit Mermaid, PlantUML, Draw.io und OpenAPI hinzu.

Hauptfunktionen für Entwickler

Gramax ist für die Teamzusammenarbeit an Dokumentation konzipiert:

• Native Git-Integration: Änderungen werden in der App vorgenommen, durchlaufen PRs und werden automatisch auf der Website bereitgestellt.
• KI-Suche und Copilot: Lokale Modelle für semantische Suche mit Quellenzitaten verbinden.
• Visueller Editor: WYSIWYG-Oberfläche mit Markdown-Export, unterstützt Diagramme und Spezifikationen.
• Öffentliches Portal: Dokumentationsseiten kostenlos selbst hosten.
• Völlig kostenlos: Open-Source ohne Freemium-Modelle oder Nutzerlimits.

Der Support ist reaktionsschnell: ein Entwickler-Chat auf Telegram für die Diskussion von Problemen.

Repository-Einrichtung Schritt für Schritt

Um ein bestehendes Git-Repository zu verbinden:

• Gehen Sie zu app.gram.ax und wählen Sie „Vorhandenes Verzeichnis hochladen“.
• Geben Sie den Anbieter an – GitHub, GitLab oder selbst gehostet.
• Wählen Sie ein Repository aus Ihrer Organisation oder Ihrem persönlichen Konto.
• Nach dem Hochladen erstellen Sie einen Ordner für Dokumente (z. B. /docs).
• Legen Sie den Ordnerpfad in den Katalogeinstellungen fest.
• Fügen Sie eine Markdown-Datei über den visuellen Editor hinzu.
• Veröffentlichen Sie Änderungen: Cloud-Button für Git Push, Pfeile für Git Pull.

Das Rückgängigmachen von Änderungen ist über die Oberfläche möglich: Diff anzeigen und zurücksetzen. Die Synchronisation ist bidirektional – Bearbeitungen im Code-Editor spiegeln sich in Gramax wider und umgekehrt. Eine Markdown-Erweiterung für VS Code wird für lokale Arbeit empfohlen.

Docs-as-Code in der Praxis

Im Gegensatz zu Cloud-Diensten eliminiert Gramax Ausfallrisiken: Alle Daten sind in Ihrem Git. Für KI-Projekte mit vertraulichen Daten gewährleistet dies Compliance ohne Kompromisse. Entwicklerteams auf mittlerem bis Senior-Niveau werden die fehlende Vendor-Lock-in und die einfache Migration zu schätzen wissen.

KI-Funktionen ermöglichen den Aufbau einer Wissensdatenbanksuche: Das Modell generiert Antworten mit präzisen Links zu MD-Dateien. Visualisierung über Mermaid vereinfacht Architekturdokumentation, und OpenAPI-Integration übernimmt API-Spezifikationen.

Veröffentlichung auf einer öffentlichen Seite: Domain konfigurieren, CI/CD über GitHub Actions für automatische Bereitstellung auf Vercel oder Netlify.

Wichtigste Erkenntnisse

• Gramax ist vollständig Open-Source, ohne versteckte Gebühren oder Limits.
• Dokumente werden in Git-Markdown gespeichert, was Versionskontrolle und Überwachung sicherstellt.
• KI-Suche-Unterstützung mit lokalen Modellen für Datenschutz.
• Native PRs und Veröffentlichung für Team-Entwicklung.
• Schneller Support über den Entwickler-Telegram-Chat.

— Editorial Team