Passer au contenu principal

​
Installation de la CLI

Prérequis : Installez Node.js avant de continuer.
1

Installez la CLI.

Exécutez la commande suivante pour installer la CLI :
npm i -g mint
2

Prévisualisez en local.

Accédez à votre répertoire de documentation (où se trouve votre fichier docs.json) et exécutez la commande suivante :
mint dev
Un aperçu local de votre documentation sera disponible sur http://localhost:3000.
Sinon, si vous ne souhaitez pas installer la CLI globalement, vous pouvez exécuter un script ponctuel : 
npx mint dev

​
Mises à jour

Si votre aperçu local n’est pas synchronisé avec ce que vous voyez en production sur le Web, mettez à jour votre CLI local : 
mint update
Si la commande mint update n’est pas disponible dans votre environnement local, réinstallez le CLI avec la dernière version : 
npm i -g mint@latest

​
Ports personnalisés

Par défaut, la CLI utilise le port 3000. Vous pouvez définir le port avec l’option --port. Pour exécuter la CLI sur le port 3333, par exemple, utilisez cette commande : 
mint dev --port 3333
Si vous tentez d’exécuter sur un port déjà utilisé, il utilisera le prochain port disponible : 
Le port 3000 est déjà utilisé. Tentative sur le port 3001.

​
Prévisualiser en tant que groupe spécifique

Si vous utilisez l’authentification partielle pour restreindre l’accès à votre documentation, vous pouvez prévisualiser en tant que groupe d’authentification spécifique avec l’option --group [groupname]. Par exemple, si vous avez un groupe nommé admin, vous pouvez prévisualiser en tant que membre de ce groupe avec la commande : 
mint dev --group admin

​
Commandes supplémentaires

Bien que mint dev soit la commande la plus utilisée, d’autres commandes permettent également de gérer votre documentation. La CLI peut vous aider à valider les liens de référence présents dans votre documentation. Pour repérer les liens cassés, utilisez la commande suivante : 
mint broken-links

​
Vérification de la spécification OpenAPI

Vous pouvez utiliser l’interface en ligne de commande (CLI) pour vérifier les erreurs de votre fichier OpenAPI avec la commande suivante : 
mint openapi-check <nomFichierOuUrlOpenAPI>
Vous pouvez fournir un nom de fichier (par exemple « ./openapi.yaml ») ou une URL (par exemple « https://petstore3.swagger.io/api/v3/openapi.json »).

​
Renommer des fichiers

Vous pouvez renommer des fichiers et mettre à jour toutes les références à ces fichiers à l’aide de la commande suivante : 
mint rename <ancienNomDeFichier> <nouveauNomDeFichier>

​
Migration des pages d’endpoint MDX

Vous pouvez migrer des pages d’endpoint MDX vers des pages générées automatiquement à partir de votre spécification OpenAPI à l’aide de la commande suivante : 
mint migrate-mdx
Cette commande convertit les pages d’endpoints MDX individuelles en pages générées automatiquement définies dans votre docs.json, déplace le contenu MDX vers l’extension x-mint de votre spécification OpenAPI et met à jour votre navigation. Consultez Migrating from MDX pour plus de détails.

​
Mise en forme

En développement local, nous recommandons d’utiliser des extensions dans votre IDE pour reconnaître et formater les fichiers MDX. Si vous utilisez Cursor, Windsurf ou VS Code, nous recommandons l’extension MDX pour VS Code pour la coloration syntaxique, ainsi que Prettier pour le formatage du code. Si vous utilisez JetBrains, nous recommandons le plugin MDX pour IntelliJ IDEA pour la coloration syntaxique, et la configuration de Prettier pour le formatage du code.

​
Dépannage

Cela peut être dû à une version obsolète de Node.js. Essayez ce qui suit :
  1. Désinstallez la version actuellement installée du CLI mint : npm uninstall -g mint
  2. Mettez à niveau vers Node.js.
  3. Réinstallez le CLI mint : npm install -g mint
Solution : Accédez à la racine de votre appareil et supprimez le dossier ~/.mintlify. Ensuite, exécutez à nouveau mint dev.
Cela est dû à l’absence des autorisations requises pour installer des paquets Node.js globalement.Solution : Essayez d’exécuter sudo npm i -g mint. Il vous sera demandé votre mot de passe, celui que vous utilisez pour déverrouiller votre ordinateur.
Cela est probablement dû à une version obsolète du CLI.Solution : Exécutez mint update pour récupérer les dernières mises à jour.
Si vous rencontrez des problèmes avec le paquet CLI, commencez par exécuter npm ls -g. Cette commande affiche les paquets installés globalement sur votre machine.Si vous n’utilisez pas npm ou ne le voyez pas dans la liste -g, essayez which mint pour localiser l’installation.Si vous avez un paquet nommé mint et un paquet nommé mintlify installés, vous devez désinstaller mintlify.
  1. Désinstallez l’ancien paquet :
  npm uninstall -g mintlify
  1. Videz le cache npm :
  npm cache clean --force
  1. Réinstallez le nouveau paquet :
npm i -g mint