Skip to main content
Prérequis : Veuillez installer Node.js (version 19 ou ultérieure) avant de poursuivre.
Veuillez migrer vers docs.json avant de poursuivre et supprimer l’ancien fichier mint.json.
Suivez ces étapes pour installer et exécuter Mintlify sur votre système d’exploitation : Étape 1 : Installez Mintlify : 
npm i -g mintlify
Étape 2 : Accédez au répertoire docs (où se trouve le fichier docs.json) et exécutez la commande suivante : 
mintlify dev
Un aperçu local de votre documentation sera accessible à l’adresse http://localhost:3000.

​
Ports personnalisés

Par défaut, Mintlify utilise le port 3000. Vous pouvez personnaliser le port sur lequel Mintlify s’exécute à l’aide de l’indicateur --port. Pour exécuter Mintlify sur le port 3333, par exemple, utilisez cette commande : 
mintlify dev --port 3333
Si vous essayez de lancer Mintlify sur un port déjà utilisé, il utilisera le port disponible suivant : 
Port 3000 is already in use. Trying 3001 instead.

​
Versions de Mintlify

Veuillez noter que chaque version de la CLI est associée à une version spécifique de Mintlify. Si votre site web local ne correspond pas à la version en Production, mettez à jour la CLI : 
npm i -g mintlify@latest
Le CLI peut vous aider à valider les liens de référence de votre documentation. Pour repérer les liens brisés, utilisez la commande suivante : 
mintlify broken-links

​
Déploiement

Nombre illimité d’éditeurs inclus avec le plan Pro et les plans supérieurs.
Si le déploiement réussit, un message de confirmation devrait s’afficher pour indiquer que toutes les vérifications ont été effectuées avec succès.

​
Formatage du code

Nous vous recommandons d’utiliser des extensions dans votre IDE pour reconnaître et formater le MDX. Si vous utilisez VSCode, pensez à l’extension MDX pour VSCode pour la coloration syntaxique et à Prettier pour le formatage du code.

​
Dépannage

Cela peut être dû à une version obsolète de Node. Essayez les étapes suivantes :
  1. Supprimez la version actuellement installée de mintlify : npm remove -g mintlify
  2. Passez à Node v19 ou à une version ultérieure.
  3. Réinstallez mintlify : npm install -g mintlify
Solution : accédez à la racine de votre machine et supprimez le dossier ~/.mintlify. Ensuite, exécutez de nouveau mintlify dev.
Vous voulez savoir ce qui a changé dans la CLI ? Consultez le changelog de la CLI.