Configurez votre environnement de développement#
Découvrez comment mettre à jour votre documentation en local et la déployer publiquement.
Modifier et prévisualiser#
Cloner votre documentation en local
Au cours de l’onboarding, nous avons créé un dépôt sur votre GitHub avec le contenu de votre documentation. Vous pouvez trouver ce dépôt sur notre tableau de bord. Pour cloner le dépôt en local, suivez ces instructions dans votre terminal.
Prévisualiser les modifications
La prévisualisation vous permet de vérifier que vos modifications s’affichent comme prévu. Nous avons créé une
interface en ligne de commande pour afficher ces changements en local. 1. Installez le
Mintlify CLI pour prévisualiser les
modifications de la documentation en local avec cette commande : npm i -g mintlify
2. Exécutez la commande suivante à la racine de votre documentation (là où
se trouve mint.json) : mintlify dev
Déployez vos modifications#
Installez notre application GitHub
Notre application GitHub déploie automatiquement vos modifications sur votre site de documentation, vous évitant ainsi de gérer vous-même les déploiements. Vous trouverez le lien d’installation sur votre tableau de bord. Une fois le bot correctement installé, une coche devrait apparaître à côté du hash du commit du dépôt.
Poussez vos modifications
Validez et poussez vos modifications vers Git pour qu’elles soient prises en compte sur votre site de documentation. Si après un push vous ne voyez pas que l’application GitHub a déployé vos modifications, vous pouvez également mettre à jour manuellement votre documentation via notre tableau de bord.
Mettez à jour votre documentation#
Ajoutez du contenu directement dans vos fichiers avec la syntaxe MDX et des composants React. Vous pouvez utiliser n’importe lequel de nos composants, ou même créer les vôtres.
Donnez du caractère à votre documentation avec une identité de marque personnalisée.
Intégrez votre spécification OpenAPI et activez l’interaction des utilisateurs avec l’API.
Tirez des insights des interactions des utilisateurs avec votre documentation.
Conservez votre documentation sur le sous-domaine de votre propre site web.