Gramax: open-source platforma pro docs-as-code s integrací Git
Týmy, které se potýkají s blokováním GitBook při synchronizaci GitHub repozitářů, nacházejí v Gramaxu plnohodnotnou open-source alternativu. Platforma ukládá dokumentaci v Markdown souborech Git, což zajišťuje plnou kontrolu nad daty bez cloudových omezení. Pro projekty s citlivými daty je to klíčové: soubory zůstávají ve vlastní infrastruktuře.
Gramax implementuje přístup docs-as-code – úpravy, schvalování změn přes pull requesty a publikace probíhají nativně v Git. Podpora vizuálního editoru zachovává Markdown jako základní formát a přidává kompatibilitu s Mermaid, PlantUML, Draw.io a OpenAPI.
Klíčové funkce pro vývojáře
Gramax je zaměřen na týmovou práci s dokumentací:
- Nativní integrace Git: Změny se provádějí v aplikaci, procházejí PR a automaticky se nasazují na web.
- AI vyhledávání a Copilot: Připojení lokálních modelů pro sémantické vyhledávání s citacemi ze zdrojů.
- Vizuální editor: WYSIWYG rozhraní s exportem do Markdown, podpora diagramů a specifikací.
- Veřejný portál: Samostatný hosting webu dokumentace bez nákladů.
- Úplná bezplatnost: Open-source bez freemium modelů nebo limitů uživatelů.
Podpora je rychlá: chat vývojářů v Telegramu pro diskusi o problémech.
Nastavení repozitáře krok za krokem
Pro připojení existujícího Git repozitáře:
- Přejděte na app.gram.ax a vyberte „Nahrát existující adresář“.
- Zadejte poskytovatele – GitHub, GitLab nebo self-hosted.
- Vyberte repozitář z organizace nebo osobního účtu.
- Po nahrání vytvořte složku pro dokumentaci (např.
/docs). - Zadejte cestu ke složce v nastavení adresáře.
- Přidejte Markdown soubor přes vizuální editor.
- Publikujte změny: tlačítko mračna pro git push, šipky pro git pull.
Zrušení změn je možné přes rozhraní: prohlédněte diff a vraťte zpět. Synchronizace je obousměrná – úpravy v kódu editoru se odrážejí v Gramaxu a naopak. Doporučuje se rozšíření pro Markdown v VS Code pro lokální práci.
Docs-as-code v praxi
Na rozdíl od cloudových služeb Gramax eliminuje rizika blokování: všechna data jsou ve vašem Git. Pro AI projekty s důvěrnými daty to zajišťuje compliance bez kompromisů. Týmy middle/senior vývojářů ocení absenci vendor lock-in a jednoduchost migrace.
AI funkce umožňují nastavit vyhledávání v znalostní bázi: model generuje odpovědi s přesnými odkazy na MD soubory. Vizualizace přes Mermaid zjednodušuje dokumentaci architektury a integrace OpenAPI – specifikací API.
Publikace na veřejný web: nastavte doménu, CI/CD přes GitHub Actions pro automatické nasazení na Vercel nebo Netlify.
Co je důležité
- Gramax je zcela open-source, bez skrytých plateb nebo limitů.
- Dokumentace je uložena v Git Markdown, což zajišťuje verzování a kontrolu.
- Podpora AI vyhledávání s lokálními modely pro soukromí.
- Nativní PR a publikace pro týmový vývoj.
- Rychlá podpora přes Telegram chat vývojářů.
— Editorial Team
Zatím žádné komentáře.