Passer au contenu principal

Démarrer la prévisualisation locale

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

Se connecter pour la recherche et l’assistant

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

Ports personnalisés

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.

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 :
mint dev --disable-openapi

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 :
mint dev --groups admin
Consultez Configuration de l’authentification pour plus d’informations sur les groupes.