Aller au contenu
Mintlify
Prise en main

Démarrage rapide

Commencez avec Mintlify : déployez votre site de documentation en quelques minutes et faites votre première modification via 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.

Vous utilisez un agent d’IA ?

Copiez l’invite suivante pour que votre agent configure votre site à votre place. Elle indique à votre agent de créer votre compte et de déployer votre site. Elle ajoute également la skill et le serveur MCP Mintlify afin d’obtenir de meilleurs résultats lorsque vous mettez à jour votre contenu.

L’invite divise le démarrage rapide en tâches que votre agent peut réaliser et lui indique de vous demander toute information dont il a besoin pendant la configuration.

Copiez-collez ce prompt pour que votre agent configure votre site Mintlify.

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.

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.site de votre site.

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

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

Page Overview du 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é.

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 i -g mint

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

Cloner votre référentiel Git

Si vous n’avez pas encore cloné votre référentiel Git en local, clonez-le avec Git :

git clone <your-repository-url>

Si votre référentiel se trouve dans l’organisation privée de Mintlify, consultez Cloner dans votre propre référentiel pour le déplacer d’abord vers votre compte.

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"
---

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.

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.

Ouvrir l’éditeur web

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

Modifier une page

Ouvrez la page Introduction et mettez à jour la description.

Page Introduction ouverte dans l’éditeur web avec la description modifiée pour afficher Hello world!.

Publier

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

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.

Ctrl+I