Passer au contenu principal

​
Installation de l’interface en ligne de commande (CLI)

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

Installer la CLI.

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

Aperçu en local.

Accédez à votre dossier de documentation (là où se trouve votre fichier docs.json) et exécutez la commande suivante :
mint dev
Un aperçu local de votre documentation sera disponible à l’adresse 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 en phase avec ce que vous voyez en ligne dans la version de production, mettez à jour votre interface en ligne de commande (CLI) locale : 
mint update
Si la commande mint update n’est pas disponible dans votre environnement local, réinstallez l’interface en ligne de commande (CLI) avec la dernière version : 
npm i -g mint@latest

​
Ports personnalisés

Par défaut, l’interface en ligne de commande (CLI) utilise le port 3000. Vous pouvez définir un port personnalisé à l’aide de l’option --port. Pour exécuter la CLI sur le port 3333, par exemple, utilisez cette commande : 
mint dev --port 3333
Si vous essayez d’exécuter sur un port déjà utilisé, le prochain port disponible sera automatiquement choisi : 
Le port 3000 est déjà utilisé. Tentative sur le port 3001 à la place.

​
Prévisualiser en tant que groupe spécifique

Si vous utilisez une authentification partielle pour restreindre l’accès à votre documentation, vous pouvez prévisualiser en tant que groupe d’authentification spécifique en utilisant 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 vous permettent également de gérer votre documentation. L’interface en ligne de commande (CLI) peut vous aider à valider les liens de référence présents dans votre documentation. Pour identifier les liens brisé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 votre fichier OpenAPI à la recherche d’erreurs 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 vers ceux-ci avec 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 MDX d’endpoint individuelles en pages générées automatiquement définies dans votre docs.json, déplace le contenu MDX vers l’extension x-mint dans votre spécification OpenAPI et met à jour votre navigation. Consultez Migrer depuis MDX pour en savoir plus.

​
Mise en forme

Lors du développement en 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 plug-in MDX pour IntelliJ IDEA pour la coloration syntaxique, ainsi que la configuration de Prettier pour le formatage du code.

​
Dépannage

Cela peut être dû à une version obsolète de Node. Essayez ce qui suit :
  1. Désinstallez la version actuellement installée de l’interface en ligne de commande (CLI) Mint : npm uninstall -g mint
  2. Mettez à jour vers Node.js.
  3. Réinstallez la CLI Mint : npm install -g mint
Solution : Accédez à la racine de votre appareil et supprimez le dossier ~/.mintlify. Ensuite, exécutez de nouveau mint dev.
Cela est dû au fait que vous n’avez pas les autorisations nécessaires pour installer globalement des paquets Node.Solution : Essayez d’exécuter sudo npm i -g mint. Votre mot de passe vous sera demandé ; il s’agit de celui que vous utilisez pour déverrouiller votre ordinateur.
Cela est probablement dû à une version obsolète de la CLI.Solution : Exécutez mint update pour récupérer les dernières modifications.
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
⌘I