​
Installation de la CLI

Prérequis : veuillez installer 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 (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 synchronisé avec ce que vous voyez en ligne 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 la 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 configurer le port à 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 tentez d’utiliser un port déjà occupé, la CLI passera au prochain port disponible : 
Le port 3000 est déjà utilisé. Essai avec le port 3001.

​
Prévisualisation en tant que groupe spécifique

Si vous utilisez l’authentification partielle pour restreindre l’accès à votre documentation, vous pouvez lancer une prévisualisation en tant que groupe d’authentification spécifique à l’aide de 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

Si mint dev est la commande la plus utilisée, d’autres commandes sont également disponibles pour gérer votre documentation. La CLI peut aider à valider les liens de référence dans votre documentation. Pour identifier 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 dans votre fichier OpenAPI avec la commande suivante : 
mint openapi-check <openapiFilenameOrUrl>
Vous pouvez fournir un nom de fichier (p. ex. ./openapi.yaml) ou une URL (p. ex. https://petstore3.swagger.io/api/v3/openapi.json).

​
Renommer des fichiers

Vous pouvez renommer des fichiers et mettre à jour toutes les références correspondantes avec la commande suivante : 
mint rename <oldFilename> <newFilename>

​
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 des pages d’endpoint 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

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 plugin MDX pour IntelliJ IDEA pour la coloration syntaxique, et de configurer Prettier pour le formatage du code.

​
Dépannage