Installer la CLI
Installez la CLI Mintlify pour prévisualiser la documentation localement, tester les modifications en direct et détecter les erreurs avant le déploiement.
- Node.js v20.17.0+ (versions LTS recommandées)
npm i -g mintVous utilisez un outil de codage IA ? Copiez le prompt suivant pour que votre agent installe la CLI et vérifie qu’elle fonctionne.
Pour créer un nouveau projet de documentation à partir du modèle de démarrage Mintlify, exécutez la commande suivante :
mint new [directory]Si vous ne spécifiez pas de répertoire, la CLI vous invite à créer un nouveau sous-répertoire ou à écraser le répertoire actuel.
Écraser le répertoire actuel supprime tous les fichiers existants.
| Flag | Description |
|---|---|
--name | Nom du projet. La CLI le demande s’il n’est pas fourni. |
--theme | Thème du projet. La CLI le demande s’il n’est pas fourni. |
--template | Modèle prédéfini. La CLI le demande s’il n’est pas fourni. |
--force | Écraser le répertoire actuel sans confirmation. |
En mode interactif, la CLI demande si vous souhaitez choisir un thème ou cloner un modèle. Pour ignorer l’invite, passez directement le flag --template :
mint new my-docs --template <template-name>Vous pouvez combiner --template avec --theme pour remplacer le thème par défaut du modèle :
mint new my-docs --template <template-name> --theme <theme>Consultez les modèles disponibles dans le dépôt mintlify/templates sur GitHub. En mode interactif, la CLI récupère et affiche automatiquement les modèles disponibles.
Dans les environnements non interactifs tels que les pipelines CI/CD ou les agents de codage IA, vous devez fournir les flags --name et --theme, ou le flag --template.
Si votre prévisualisation locale n’est pas synchronisée avec votre documentation déployée, mettez à jour la CLI vers la dernière version :
mint updateSi mint update n’est pas disponible dans votre version, réinstallez la CLI avec la dernière version :
npm i -g mint@latestPour la coloration syntaxique et le formatage du code dans les fichiers MDX, nous recommandons les extensions suivantes :
- Cursor, Devin Desktop, VS Code : Extension MDX pour VS Code et Prettier
- JetBrains : Plugin MDX pour IntelliJ IDEA et Prettier