Doctave

Doctave est une plateforme de documentation qui combine la flexibilité de l’écriture en Markdown avec la puissance d’un hébergement professionnel de documentation. Vous rédigez votre documentation dans des fichiers texte simples, les stockez dans Git aux côtés de votre code, et Doctave se charge de les transformer en sites web de documentation beaux et consultables.

La plateforme prend en charge à la fois les guides Markdown classiques et les spécifications OpenAPI pour la documentation des API. Elle crée automatiquement des environnements de prévisualisation lorsque vous apportez des modifications, permettant à votre équipe de revoir les mises à jour avant publication. Tout reste dans votre dépôt Git, vous offrant un contrôle total des versions de votre documentation.

Doctave Studio est l’application de bureau compagnon qui fournit des aperçus en temps réel, des suggestions d’auto-complétion, la vérification des liens cassés et la correction orthographique. Ensemble, ces outils aident les équipes à créer une documentation toujours à jour et précise.

Commencer avec Doctave est simple. Voici comment l'utiliser efficacement :

• Créez un dossier de documentation dans votre dépôt de code et rédigez votre contenu en utilisant des fichiers Markdown. Incluez un fichier README.md comme page de démarrage.

• Installez Doctave Studio sur votre ordinateur pour prévisualiser votre documentation localement avec des mises à jour en temps réel pendant que vous écrivez.

• Configurez votre fichier doctave.yml pour définir la structure de votre documentation, les couleurs du thème et les liens de navigation.

• Connectez votre dépôt Git à Doctave via leur plateforme. À chaque fois que vous poussez des modifications, Doctave met automatiquement à jour votre documentation publiée.

• Pour la documentation API, ajoutez votre fichier de spécification OpenAPI à votre dépôt. Doctave générera automatiquement des pages de référence API interactives.

• Utilisez les branches Git pour gérer différentes versions de votre documentation. Créez des pull requests pour revoir les modifications avant publication, et Doctave générera des liens de prévisualisation pour chaque pull request.

• Flux de travail de documentation basé sur Git avec contrôle de version

• Éditeur de bureau Doctave Studio avec aperçu en temps réel

• Support de la spécification OpenAPI pour la documentation des API

• Environnements d’aperçu automatiques pour les demandes de tirage

• Gestion de documentation multi-version

• Recherche intégrée dans tout le contenu

• Options de personnalisation de la marque et du thème

• Analyse des lecteurs et collecte de retours

• Intégration CI/CD pour déploiement automatique

• Options de documentation protégée par mot de passe