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

Gramax : Plateforme Open-Source Docs-as-Code avec Intégration Git

Les équipes confrontées à des problèmes de synchronisation entre GitBook et les dépôts GitHub trouvent en Gramax une alternative open-source robuste. La plateforme stocke la documentation dans des fichiers Markdown Git, garantissant un contrôle total des données sans restrictions cloud. Pour les projets contenant des données sensibles, c'est crucial : les fichiers restent dans votre propre infrastructure.

Gramax met en œuvre une approche docs-as-code—l'édition, l'approbation des modifications via des pull requests et la publication se font nativement dans Git. Le support d'un éditeur visuel maintient Markdown comme format de base, ajoutant la compatibilité avec Mermaid, PlantUML, Draw.io et OpenAPI.

Fonctionnalités Clés pour les Développeurs

Gramax est conçu pour la collaboration d'équipe sur la documentation :

• Intégration Native Git : Les modifications sont effectuées dans l'application, passent par des PR et sont automatiquement déployées sur le site.
• Recherche IA et Copilot : Connectez des modèles locaux pour une recherche sémantique avec citations des sources.
• Éditeur Visuel : Interface WYSIWYG avec export Markdown, prenant en charge les diagrammes et spécifications.
• Portail Public : Hébergez vous-même des sites de documentation sans frais.
• Entièrement Gratuit : Open-source sans modèles freemium ni limites d'utilisateurs.

Le support est réactif : un chat développeur sur Telegram pour discuter des problèmes.

Configuration du Dépôt Étape par Étape

Pour connecter un dépôt Git existant :

• Allez sur app.gram.ax et sélectionnez "Upload Existing Directory."
• Spécifiez le fournisseur—GitHub, GitLab ou auto-hébergé.
• Choisissez un dépôt de votre organisation ou compte personnel.
• Après le téléchargement, créez un dossier pour la documentation (par exemple, /docs).
• Définissez le chemin du dossier dans les paramètres du catalogue.
• Ajoutez un fichier Markdown via l'éditeur visuel.
• Publiez les modifications : bouton cloud pour git push, flèches pour git pull.

Annuler les modifications est possible via l'interface : visualisez le diff et revenez en arrière. La synchronisation est bidirectionnelle—les modifications dans l'éditeur de code se reflètent dans Gramax, et vice versa. Une extension Markdown pour VS Code est recommandée pour le travail local.

Docs-as-Code en Pratique

Contrairement aux services cloud, Gramax élimine les risques de blocage : toutes les données sont dans votre Git. Pour les projets IA avec des données confidentielles, cela garantit la conformité sans compromis. Les équipes de développeurs de niveau intermédiaire à senior apprécieront l'absence de verrouillage fournisseur et la facilité de migration.

Les fonctionnalités IA permettent de configurer la recherche de base de connaissances : le modèle génère des réponses avec des liens précis vers les fichiers MD. La visualisation via Mermaid simplifie la documentation d'architecture, et l'intégration OpenAPI gère les spécifications API.

Publication sur un site public : configurez un domaine, CI/CD via GitHub Actions pour un déploiement automatique sur Vercel ou Netlify.

Points Clés à Retenir

• Gramax est entièrement open-source, sans frais cachés ni limites.
• La documentation est stockée en Markdown Git, assurant le contrôle de version et la supervision.
• Support de recherche IA avec modèles locaux pour la confidentialité.
• PR et publication natifs pour le développement en équipe.
• Support rapide via le chat développeur Telegram.

— Editorial Team