Démarrage rapide

Déployez votre site de documentation et effectuez votre première modification.

Après avoir terminé ce guide, vous disposerez d’un site de documentation en ligne prêt à être personnalisé et mis à jour.

​

Avant de commencer

Mintlify utilise une approche docs-as-code pour gérer votre documentation. Chaque page de votre site possède un fichier correspondant, stocké dans votre référentiel de documentation. Vous pouvez utiliser votre propre référentiel Git ou un référentiel hébergé par Mintlify.

Choisissez l’approche de référentiel qui vous convient le mieux.

Hébergé par Mintlify

Mintlify crée un référentiel GitHub privé connecté à votre déploiement Mintlify.

Choisissez cette option si :

• Vous travaillerez uniquement dans l’éditeur web et ne voulez pas utiliser Git localement.
• Vous voulez démarrer rapidement sans connecter de référentiel.
• Vous voulez que Mintlify gère votre référentiel de documentation pour vous.

Votre propre référentiel

Connectez votre propre référentiel Git à votre déploiement Mintlify.

Choisissez cette option si :

• Vous travaillerez localement et voulez synchroniser avec votre référentiel distant.
• Vous avez déjà un référentiel pour votre documentation.
• Vous voulez que votre documentation soit sous votre propre organisation GitHub.

Vous ne savez pas quoi choisir ? Commencez avec Hébergé par Mintlify. Vous pourrez migrer vers votre propre référentiel à tout moment si cela correspond mieux à vos besoins.

​

Déployez votre site de documentation

Hébergé par Mintlify

1. Créez votre compte

   Allez sur mintlify.com/start et créez votre compte.

2. Ignorer la connexion à GitHub

   Lorsque vous êtes invité à connecter GitHub, cliquez sur Skip pour utiliser un référentiel hébergé par Mintlify.

3. Terminer l'onboarding

   Suivez les étapes d’onboarding pour configurer votre documentation. Mintlify crée automatiquement un référentiel privé dans l’organisation mintlify-community et configure la GitHub App pour vous.

4. Votre site est déployé

   Votre documentation est immédiatement déployée et accessible à votre URL .mintlify.app.

Votre propre référentiel

1. Créez votre compte

   Allez sur mintlify.com/start et créez votre compte.

2. Connecter GitHub

   Lorsque vous y êtes invité, connectez-vous à votre compte GitHub et authentifiez-vous.

3. Terminer l'onboarding

   Suivez les étapes d’onboarding restantes pour créer un référentiel et accéder à votre Dashboard.

4. Installer la GitHub App

   Installez la GitHub App de Mintlify pour activer les déploiements automatiques. Cela permet à Mintlify de se synchroniser avec votre référentiel et de déployer automatiquement les modifications lorsque vous faites un push.

5. Facultatif : sélectionner un référentiel

   Si vous souhaitez utiliser un autre référentiel que celui créé pendant l’onboarding pour votre documentation, sélectionnez-le sur la page Paramètres Git de votre Dashboard. Votre référentiel de documentation doit contenir un fichier docs.json valide pour être déployé.

6. Votre site est déployé

   Votre documentation est déployée et accessible à votre URL .mintlify.app. Les prochaines modifications que vous pousserez vers votre référentiel déclencheront automatiquement de nouveaux déploiements.

Pour en savoir plus sur la GitHub App et ses autorisations, consultez GitHub.

​

Voir votre site déployé

Votre site de documentation est maintenant déployé à l’adresse https://<your-project-name>.mintlify.app.

Trouvez l’URL exacte de votre site sur la page Overview de votre Tableau de bord Mintlify.

Votre site est immédiatement prêt à être consulté. Utilisez cette URL pour effectuer des tests et la partager avec votre équipe. Avant de le partager avec vos utilisateurs, vous voudrez peut-être ajouter un domaine personnalisé.

​

Effectuer votre première modification

1. Ouvrir l’éditeur web

   Accédez à l’éditeur web depuis votre Dashboard.

2. Modifier une page

   Ouvrez index.mdx et modifiez la description dans le frontmatter :

   ---
   title: "Introduction"
   description: "Votre description personnalisée ici"
   ---
   
3. Publier

   Cliquez sur le bouton Publish en haut à droite de la barre d’outils de l’éditeur web.

4. Afficher en ligne

   Sur la page Overview de votre Dashboard, vous pouvez voir l’état de déploiement de votre site. Une fois le déploiement terminé, actualisez votre site de documentation pour voir vos modifications en ligne.

​

Prochaines étapes

Découvrir l’éditeur web

Explorez les fonctionnalités d’édition et les flux de travail.

Configurer un environnement de développement local

Utilisez l’interface en ligne de commande (CLI) pour prévisualiser votre documentation en local pendant que vous la rédigez et la mettez à jour.

Ajouter un domaine personnalisé

Utilisez votre propre domaine pour votre site de documentation.