L’URL de votre site est disponible immédiatement. Utilisez cette URL pour les tests et le partage avec votre équipe pendant la configuration de votre site de documentation.
### Installer l’application GitHub
Mintlify propose une GitHub App qui automatise le déploiement lorsque vous poussez des modifications vers votre référentiel.
Installez la GitHub App en suivant les instructions de la checklist d’onboarding ou depuis votre Dashboard.
1. Accédez à **Settings** dans votre Tableau de bord Mintlify.
2. Sélectionnez **GitHub App** dans la barre latérale.
3. Sélectionnez **Install GitHub App**. Un nouvel onglet s’ouvre sur la page d’installation de la GitHub App.
4. Sélectionnez l’organisation ou le compte utilisateur où vous souhaitez installer l’app.
5. Sélectionnez les référentiels que vous souhaitez connecter.
## Méthodes d’édition
Mintlify propose deux méthodes pour créer et maintenir votre documentation :
## Flux de travail basé sur le code
Le flux de travail basé sur le code s’intègre à votre environnement de développement existant et à vos dépôts Git. Ce flux de travail est idéal pour les é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 référentiel créé lors de l’intégration.
2. Ouvrez `index.mdx` et repérez le début du fichier :
```mdx index.mdx theme={null}
---
title: "Introduction"
description: "Ceci est l'introduction de la documentation"
---
```
3. Mettez à jour le champ `title` sur `"Hello World"`.
```mdx index.mdx {2} theme={null}
---
title: "Bonjour le monde"
description: "Ceci est l'introduction à la documentation"
---
```
### Prévisualiser les modifications
Pour afficher un aperçu local des modifications, exécutez la commande suivante :
```bash theme={null}
mint dev
```
Votre aperçu sera disponible à `localhost:3000`.
### Envoyer les modifications
Lorsque vous êtes prêt à publier vos modifications, envoyez-les vers votre référentiel.
Mintlify détecte automatiquement les modifications, génère votre documentation et déploie les mises à jour sur votre site. Surveillez l’état du déploiement dans l’historique des commits de votre référentiel GitHub ou sur le [Dashboard](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. Il convient particulièrement à celles et ceux qui souhaitent travailler dans leur navigateur web sans recourir à des outils de développement locaux supplémentaires.
### Accéder à l’éditeur web
1. Connectez-vous à votre [Dashboard](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 :
Recherchez et sélectionnez `index.mdx` dans l’explorateur de fichiers.
Puis, dans l’éditeur, mettez à jour le champ title avec « Hello World ».
### Publier vos modifications
Lorsque vous êtes satisfait de vos modifications, cliquez sur le bouton **Publish** dans l’angle supérieur droit. Vos changements sont immédiatement déployés 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 fournies pour configurer les paramètres DNS auprès de votre fournisseur de domaine.
## Prochaines étapes
Félicitations ! Vous avez déployé votre site de documentation avec Mintlify. Voici des étapes recommandées pour améliorer votre documentation :
## Dépannage
Si vous rencontrez des problèmes lors de la configuration, consultez ces solutions courantes :