Passer au contenu principal

​
Prérequis

  • Node.js v20.17.0+ (versions LTS recommandées)

​
Installer la CLI

npm i -g mint

​
Créer un nouveau projet

Pour créer un nouveau projet de documentation à partir du modèle de démarrage Mintlify, exécutez la commande suivante : 
mint new [directory]
Si vous ne spécifiez pas de répertoire, la CLI vous invite à créer un nouveau sous-répertoire ou à écraser le répertoire actuel.
Écraser le répertoire actuel supprime tous les fichiers existants.
FlagDescription
--nameNom du projet. La CLI le demande s’il n’est pas fourni.
--themeThème du projet. La CLI le demande s’il n’est pas fourni.
--forceÉcraser le répertoire actuel sans confirmation.
Dans les environnements non interactifs tels que les pipelines CI/CD ou les agents de codage IA, vous devez fournir les flags --name et --theme.

​
Mise à jour

Si votre prévisualisation locale n’est pas synchronisée avec votre documentation déployée, mettez à jour la CLI vers la dernière version : 
mint update
Si mint update n’est pas disponible dans votre version, réinstallez la CLI avec la dernière version : 
npm i -g mint@latest

​
Formatage

Pour la coloration syntaxique et le formatage du code dans les fichiers MDX, nous recommandons les extensions suivantes :

​
Dépannage

Cela peut être dû à une version obsolète de Node.js. Essayez les étapes suivantes :
  1. Désinstallez la version actuelle de la CLI mint : npm uninstall -g mint
  2. Mettez à jour vers Node.js v20.17.0+.
  3. Réinstallez la CLI mint : npm install -g mint
Solution : Allez à la racine de votre appareil et supprimez le dossier ~/.mintlify. Ensuite, exécutez à nouveau mint dev.
Cela est dû au manque de permissions pour installer des packages Node de manière globale.Solution : Essayez d’exécuter sudo npm i -g mint. Lorsque vous y êtes invité, entrez le mot de passe 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 obtenir les dernières modifications.
Si vous rencontrez des problèmes avec le package CLI, exécutez d’abord npm ls -g pour voir les packages installés globalement. Si vous n’utilisez pas npm, essayez which mint pour localiser l’installation.Si vous avez à la fois le package mint et le package mintlify installés, désinstallez mintlify :
npm uninstall -g mintlify
npm cache clean --force
npm i -g mint
Si vous exécutez mint version et que la version du client s’affiche comme none, la CLI peut ne pas être en mesure de télécharger l’application client en raison d’un pare-feu d’entreprise ou d’un VPN.Solution : Demandez à votre administrateur informatique d’ajouter releases.mintlify.com à la liste d’autorisation de votre réseau.

Sujets connexes

GitHub Enterprise ServerGitHubAutomatiser la documentation quand le code change