Passer au contenu principal
Graphique décoratif représentant la CLI. Utilisez la CLI pour prévisualiser votre documentation en local pendant que vous écrivez et modifiez. Affichez les changements en temps réel avant le déploiement, testez l’apparence et les fonctionnalités de votre site de documentation, et détectez des problèmes tels que des liens rompus ou des problèmes d’accessibilité. La CLI propose également des utilitaires pour maintenir votre documentation, notamment des commandes pour renommer des fichiers, valider des spécifications OpenAPI et migrer du contenu entre différents formats.

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

Prérequis : la CLI requiert Node.js v19 ou une version ultérieure.
Exécutez la commande suivante pour installer la CLI : 
npm i -g mint

​
Aperçu local

Pour générer un aperçu local, rendez-vous dans votre répertoire de documentation (l’emplacement de votre fichier docs.json) et exécutez la commande suivante : 
mint dev
Un aperçu local de votre documentation est disponible à l’adresse http://localhost:3000. Sinon, si vous ne souhaitez pas installer l’interface en ligne de commande (CLI) globalement, vous pouvez exécuter un script ponctuel : 
npx mint dev

​
Ports personnalisés

Par défaut, l’interface en ligne de commande (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 la commande suivante : 
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é. Utilisation du 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 --groups [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 --groups admin

​
Créer un nouveau projet

Pour créer un nouveau projet de documentation, exécutez la commande suivante : 
mint new [répertoire]
Cette commande clone le kit de démarrage dans un répertoire donné. Si aucun répertoire n’est précisé, l’interface en ligne de commande (CLI) vous propose de créer un nouveau sous-dossier ou d’écraser le répertoire actuel.
Si vous écrasez le répertoire actuel, tous les fichiers qui s’y trouvent seront supprimés.
L’outil CLI vous demande un nom de projet et un thème pour finaliser la configuration de votre projet. Vous pouvez exécuter mint new avec les options suivantes :
  • --theme : définir le thème du nouveau projet.
  • --name : définir le nom du nouveau projet.
  • --force : écraser le répertoire actuel s’il existe déjà.
Par exemple, pour créer un nouveau projet dans le répertoire docs avec le nom my-project et le thème linden, exécutez la commande suivante : 
mint new docs --name my-project --theme linden

​
Mettre à jour l’interface en ligne de commande (CLI)

Si votre aperçu local n’est pas en phase avec ce que vous voyez sur le Web dans la version de production, mettez à jour votre CLI locale : 
mint update
Si la commande « mint update » n’est pas disponible dans votre version locale, réinstallez l’interface en ligne de commande (CLI) avec la dernière version : 
npm i -g mint@latest

​
Commandes supplémentaires

Identifiez les liens internes brisés avec la commande suivante : 
mint broken-links

​
Détecter les problèmes d’accessibilité

Testez les rapports de contraste des couleurs et recherchez les textes alternatifs manquants pour les images et les vidéos de votre documentation avec la commande suivante : 
mint a11y

​
Vérifier la spécification OpenAPI

Vérifiez votre fichier OpenAPI à la recherche d’erreurs avec la commande suivante : 
mint openapi-check <nom de fichier OpenAPI ou URL>
Passez un nom de fichier (par exemple « ./openapi.yaml ») ou une URL (par exemple « https://petstore3.swagger.io/api/v3/openapi.json »).

​
Renommer des fichiers

Renommez les fichiers et mettez à jour toutes leurs références avec la commande suivante : 
mint rename <chemin/vers/ancien-nom-de-fichier> <chemin/vers/nouveau-nom-de-fichier>

​
Migrer les pages d’endpoints MDX

Migrez les pages d’endpoints MDX vers des pages générées automatiquement à partir de votre spécification OpenAPI avec la commande suivante : 
mint migrate-mdx
Cette commande convertit les pages MDX d’endpoint individuelles en pages générées automatiquement, telles que 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 Migration depuis MDX pour plus de détails.

​
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