Démarrage rapide

Commencez avec Mintlify en déployant votre site de documentation en quelques minutes et en effectuant votre première modification de contenu avec l’éditeur web ou Git.

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.

Lorsque vous connectez votre référentiel de documentation à votre projet, vous pouvez travailler sur votre documentation localement ou dans l’éditeur web et synchroniser toutes les modifications avec votre référentiel distant.

Vous utilisez un outil de développement assisté par IA ?

Copiez l’invite suivante pour ajouter la skill et le serveur MCP Mintlify afin d’obtenir de meilleurs résultats lors de la mise à jour de votre documentation.

Installez la skill Mintlify pour obtenir le contexte sur la structure d'un projet Mintlify, ses composants et les bonnes pratiques de documentation :

npx skills add https://mintlify.com/docs

Ajoutez ensuite le serveur MCP Mintlify pour accéder à la recherche dans la documentation. Suivez les instructions de configuration sur https://www.mintlify.com/docs/ai/model-context-protocol.md

CopiéCopier le promptOuvrir dans Cursor

​

Déployer votre site de documentation

Si votre code ou votre documentation est déjà hébergé dans un référentiel GitHub public, générez automatiquement votre site de documentation à la place.

Remplacez github.com par mintlify.com dans n’importe quelle URL de référentiel public :

https://mintlify.com/github-org/repo-name

Accédez à mintlify.com/start et suivez le processus d’onboarding. Pendant l’onboarding, vous connectez votre compte GitHub, créez ou sélectionnez un référentiel pour votre documentation et installez la GitHub App afin d’activer les déploiements automatiques.

Après l’onboarding, votre site de documentation est déployé et accessible via l’URL .mintlify.app de votre site.

Facultatif : ignorer la connexion à GitHub pendant l'onboarding

Si vous souhaitez démarrer rapidement sans connecter votre propre référentiel, vous pouvez ignorer la connexion à GitHub pendant l’onboarding. Mintlify crée un référentiel privé dans une organisation privée et configure automatiquement la GitHub App pour vous.

Cela vous permet d’utiliser immédiatement l’éditeur web et de migrer vers votre propre référentiel plus tard.

​

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

CLI

1. Installer la CLI

   La CLI nécessite Node.js v20.17.0 ou une version supérieure. Utilisez une version LTS pour plus de stabilité.

   npm

   npm i -g mint
   

   Consultez Installer la CLI pour plus de détails et de conseils de dépannage.

2. Cloner votre référentiel Git

   Si vous n’avez pas encore cloné votre référentiel Git en local, suivez les instructions dans Cloner votre référentiel.

3. Modifier une page

   Ouvrez index.mdx dans votre éditeur préféré et modifiez la description dans le frontmatter :

   ---
   title: "Introduction"
   description: "Votre description personnalisée ici"
   ---
   
4. Prévisualiser en local

   Exécutez la commande suivante depuis votre répertoire de documentation :

   mint dev
   

   Affichez l’aperçu à l’adresse http://localhost:3000.

5. Pousser vos modifications

   Effectuez un commit puis poussez vos modifications pour déclencher un déploiement :

   git add .
   git commit -m "Update description"
   git push
   

   Mintlify déploie automatiquement vos modifications. Consultez l’état du déploiement sur la page Overview de votre Dashboard.

Éditeur web

1. Ouvrir l’éditeur web

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

2. Modifier une page

   Ouvrez la page Introduction et mettez à jour la description.

   
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

Utiliser l’éditeur web

Modifiez la documentation dans votre navigateur et prévisualisez l’apparence de vos pages lorsqu’elles sont publiées.

Explorer les commandes CLI

Repérez les liens brisés, vérifiez l’accessibilité, validez les spécifications OpenAPI et bien plus encore.

Ajouter un domaine personnalisé

Utilisez votre propre domaine pour votre site de documentation.