Prévisualisation locale

• 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.

Naviguez jusqu’au répertoire de votre documentation contenant votre fichier docs.json et exécutez :

mint dev

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 :

mint dev --no-open

Pour générer une prévisualisation sans installer la CLI globalement, exécutez :

npx mint dev

Vous devez authentifier la CLI avec votre compte Mintlify pour activer la recherche et l’assistant.

mint login

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, que des commandes comme mint automations utilisent.

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 :

mint status

Pour vous déconnecter, exécutez :

mint logout

Par défaut, la CLI utilise le port 3000. Pour utiliser un port différent, utilisez le flag --port :

mint dev --port 3333

Si le port est déjà utilisé, la CLI essaie automatiquement le port disponible suivant.

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 :

mint dev --disable-openapi

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 :

mint dev --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.

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 :

mint dev --groups admin

Consultez Configuration de l’authentification pour plus d’informations sur les groupes.