Gramax: open-source platforma do dokumentacji jako kodu z integracją Git
Zespoły, które napotykają blokady GitBook przy synchronizacji repozytoriów GitHub, znajdują w Gramax pełnoprawną open-source alternatywę. Platforma przechowuje dokumentację w plikach Markdown w Git, zapewniając pełną kontrolę nad danymi bez ograniczeń chmurowych. Dla projektów z wrażliwymi danymi jest to kluczowe: pliki pozostają we własnej infrastrukturze.
Gramax realizuje podejście docs-as-code — edycja, zatwierdzanie zmian przez pull request'y i publikacja odbywają się natywnie w Git. Obsługa edytora wizualnego zachowuje Markdown jako podstawowy format, dodając kompatybilność z Mermaid, PlantUML, Draw.io i OpenAPI.
Kluczowe możliwości dla deweloperów
Gramax jest ukierunkowana na pracę zespołową z dokumentacją:
- Natywna integracja Git: Zmiany wprowadzane są w aplikacji, przechodzą przez PR i są automatycznie wdrażane na stronie.
- Wyszukiwanie AI i Copilot: Podłączanie lokalnych modeli do wyszukiwania semantycznego z cytatami ze źródeł.
- Edytor wizualny: Interfejs WYSIWYG z eksportem do Markdown, obsługa diagramów i specyfikacji.
- Publiczny portal: Samodzielny hosting strony dokumentacji bez kosztów.
- Pełna bezpłatność: Open-source bez modeli freemium lub limitów użytkowników.
Wsparcie jest szybkie: czat deweloperów w Telegramie do dyskusji o problemach.
Konfiguracja repozytorium krok po kroku
Aby podłączyć istniejące repozytorium Git:
- Przejdź do app.gram.ax i wybierz „Załaduj istniejący katalog”.
- Wskaż dostawcę — GitHub, GitLab lub self-hosted.
- Wybierz repozytorium z organizacji lub osobistego konta.
- Po załadowaniu utwórz folder na dokumentację (np.
/docs). - Wskaż ścieżkę do folderu w ustawieniach katalogu.
- Dodaj plik Markdown przez edytor wizualny.
- Opublikuj zmiany: przycisk chmurki dla git push, strzałki dla git pull.
Cofanie zmian jest możliwe przez interfejs: przejrzyj diff i wycofaj. Synchronizacja jest dwukierunkowa — poprawki w edytorze kodu odzwierciedlają się w Gramax i odwrotnie. Zalecane jest rozszerzenie do Markdown w VS Code do pracy lokalnej.
Docs-as-code w praktyce
W przeciwieństwie do usług chmurowych, Gramax eliminuje ryzyko blokady: wszystkie dane są w Twoim Git. Dla projektów AI z poufnymi danymi zapewnia to zgodność bez kompromisów. Zespoły middle/senior deweloperów docenią brak uzależnienia od dostawcy i prostotę migracji.
Funkcje AI pozwalają skonfigurować wyszukiwanie po bazie wiedzy: model generuje odpowiedzi z dokładnymi odnośnikami do plików MD. Wizualizacja przez Mermaid upraszcza dokumentację architektury, a integracja OpenAPI — specyfikacji API.
Publikacja na publicznej stronie: skonfiguruj domenę, CI/CD przez GitHub Actions do automatycznego wdrożenia na Vercel lub Netlify.
Co jest ważne
- Gramax jest w pełni open-source, bez ukrytych opłat lub limitów.
- Dokumentacja przechowywana jest w Git Markdown, zapewniając wersjonowanie i kontrolę.
- Obsługa wyszukiwania AI z lokalnymi modelami dla prywatności.
- Natywne PR i publikacja dla zespołowego rozwoju.
- Szybkie wsparcie przez czat deweloperów w Telegramie.
— Editorial Team
Brak komentarzy.