L’URL de votre site est disponible immédiatement. Utilisez-la pour effectuer des tests et la partager avec votre équipe pendant la configuration de votre site de documentation.
### Installer l’application GitHub
Mintlify propose une application GitHub qui automatise le déploiement lorsque vous poussez des modifications vers votre dépôt.
Installez l’application GitHub en suivant les instructions de la checklist d’onboarding ou depuis votre tableau de bord.
1. Rendez-vous dans **Settings** de votre tableau de bord Mintlify.
2. Sélectionnez **GitHub App** dans la barre latérale.
3. Cliquez sur **Install GitHub App**. Un nouvel onglet s’ouvre vers la page d’installation de l’application GitHub.
4. Choisissez l’organisation ou le compte utilisateur où vous souhaitez installer l’application.
5. Sélectionnez les dépôts que vous souhaitez connecter.
## Flux d’édition
Mintlify propose deux workflows pour créer et maintenir votre documentation :
## Flux de travail basé sur le code
Ce flux de travail s’intègre à votre environnement de développement et à vos dépôts Git existants. Il convient particulièrement aux équipes techniques qui souhaitent gérer la documentation en parallèle du code.
### Installer la CLI
Pour travailler localement avec votre documentation, installez l’interface en ligne de commande (CLI), appelée [mint](https://www.npmjs.com/package/mint), en exécutant la commande suivante dans votre terminal :
### Modifier la documentation
Après avoir configuré votre environnement, vous pouvez commencer à modifier vos fichiers de documentation. Par exemple, mettez à jour le titre de la page d’introduction :
1. Ouvrez le dépôt créé lors de l’intégration.
2. Ouvrez `index.mdx` et repérez le début du fichier :
```mdx index.mdx
---
title: "Introduction"
description: "Voici l’introduction de la documentation"
---
```
3. Mettez à jour le champ `title` sur `"Hello World"`.
```mdx index.mdx {2}
---
title: "Bonjour, monde"
description: "Introduction à la documentation"
---
```
### Prévisualiser les modifications
Pour prévisualiser les modifications en local, exécutez la commande suivante :
```bash
mint dev
```
Votre aperçu sera disponible à l’adresse `localhost:3000`.
### Pousser les modifications
Lorsque vous êtes prêt à publier vos modifications, poussez-les vers votre dépôt.
Mintlify détecte automatiquement les changements, génère votre documentation et déploie les mises à jour sur votre site. Suivez l’état du déploiement dans l’historique des commits de votre dépôt GitHub ou sur le [tableau de bord](https://dashboard.mintlify.com).
Une fois le déploiement terminé, votre dernière mise à jour sera disponible à `
## Flux de travail de l’Éditeur web
Le flux de travail de l’Éditeur web propose une interface WYSIWYG (what-you-see-is-what-you-get) pour créer et modifier la documentation. Ce flux est idéal pour celles et ceux qui souhaitent travailler dans leur navigateur sans recourir à des outils de développement locaux supplémentaires.
### Accéder à l’éditeur web
1. Connectez-vous à votre [tableau de bord](https://dashboard.mintlify.com).
2. Sélectionnez **Editor** dans la barre latérale gauche.
### Modifier la documentation
Dans l’Éditeur web, vous pouvez parcourir vos fichiers de documentation dans la barre latérale. Mettons à jour la page d’introduction :
Repérez et sélectionnez `index.mdx` dans l’explorateur de fichiers.
Puis, dans l’éditeur, modifiez le champ du titre en « Hello World ».
### Publier vos modifications
Lorsque vous êtes satisfait de vos modifications, cliquez sur le bouton **Publier** dans l’angle supérieur droit. Vos modifications sont immédiatement déployées sur votre site de documentation.
## Ajouter un domaine personnalisé
Bien que votre sous-domaine `
Saisissez votre domaine (par exemple, `docs.yourcompany.com`) et suivez les instructions pour configurer les enregistrements DNS auprès de votre fournisseur de domaine.
## Prochaines étapes
Félicitations ! Vous avez déployé votre site de documentation avec Mintlify. Voici les prochaines étapes recommandées pour améliorer votre documentation :
## Dépannage
Si vous rencontrez des problèmes pendant la configuration, consultez ces solutions courantes :