Passer au contenu principal

​
Prérequis

  • La CLI Mintlify installée globalement, ou exécutez les commandes avec npx mint.
  • Un répertoire de documentation contenant un fichier docs.json valide.

​
Démarrer la prévisualisation locale

Naviguez jusqu’au répertoire de votre documentation contenant votre fichier docs.json et exécutez :
La prévisualisation locale démarre à l’adresse http://localhost:3000. Au fur et à mesure que vous modifiez, les changements apparaissent en temps réel. Par défaut, la prévisualisation s’ouvre automatiquement dans votre navigateur. Pour empêcher l’ouverture du navigateur, utilisez le flag --no-open :
Pour générer une prévisualisation sans installer la CLI globalement, exécutez :
Si vous rédigez dans VS Code ou Cursor, l’extension Mintlify MDX exécute cette prévisualisation dans un panneau à côté de votre éditeur et la fait défiler pour correspondre à la page que vous modifiez.

​
Se connecter pour la recherche et l’assistant

Vous devez authentifier la CLI avec votre compte Mintlify pour activer la recherche et l’assistant.
Après vous être authentifié avec la commande mint login, la CLI stocke vos identifiants dans ~/.config/mintlify/config.json afin que vous restiez connecté entre les sessions. La CLI vous invite également à sélectionner un projet par défaut. Une fois connecté, exécutez mint dev pour démarrer la prévisualisation locale avec la recherche et l’assistant activés. L’assistant utilise le même contenu indexé que votre site de documentation déployé. Pour vérifier l’état de votre authentification, exécutez :
Pour vous déconnecter, exécutez :

​
Ports personnalisés

Par défaut, la CLI utilise le port 3000. Pour utiliser un port différent, utilisez le flag --port :
Si le port est déjà utilisé, la CLI essaie automatiquement le port disponible suivant.

​
Ignorer le traitement OpenAPI

Si vous avez de nombreux fichiers OpenAPI, ignorez le traitement OpenAPI pendant le développement local pour améliorer les performances avec le flag --disable-openapi :

​
Désactiver le préchargement de la navigation

Par défaut, la prévisualisation locale précharge les pages voisines pour que la navigation entre elles semble instantanée. Sur les très grands sites, cela peut ralentir la page que vous consultez, car de nombreuses pages sont compilées en arrière-plan en même temps. Si vous avez des milliers de pages et constatez des chargements de page lents lors de la prévisualisation locale, désactivez le préchargement avec le flag --disable-prefetch :
Avec le préchargement désactivé, les pages ne sont compilées que lorsque vous y accédez. Les chargements de page individuels prennent plus de temps qu’une page préchargée, mais la page que vous demandez n’est pas en concurrence avec la compilation en arrière-plan.

​
Prévisualiser en tant que groupe spécifique

Si vous utilisez le contrôle d’accès basé sur les groupes, prévisualisez en tant que groupe d’authentification spécifique avec le flag --groups :
Par défaut, la prévisualisation locale affiche le contenu en tant que lecteur non connecté. Pour vérifier le contenu <Visibility for="signed-in">, prévisualisez en tant que lecteur connecté sans groupe à l’aide du flag --signed-in. Le flag --groups prévisualise également en tant que lecteur connecté.
Consultez Configuration de l’authentification pour plus d’informations sur les groupes.

Sujets connexes

Mintlify CLIRéférence des commandes de la CLI MintlifyInstaller la CLI