- La CLI Mintlify installée globalement, ou exécutez les commandes avec
npx mint.
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 dans un répertoire qui ne contient pas de fichier docs.json, la CLI génère un fichier docs.json à partir de la structure de votre répertoire. La navigation générée suit ces règles :
- Crée un groupe nommé Introduction pour les fichiers Markdown et MDX situés à la racine du répertoire.
- Crée un groupe pour chaque sous-répertoire de premier niveau, et les sous-répertoires imbriqués deviennent des sous-groupes.
- Les pages nommées
indexoureadmeapparaissent en premier dans leur groupe. Les autres pages et dossiers sont triés par ordre alphabétique, ou numérique si les titres contiennent des nombres. - Les noms de groupes reprennent les noms des sous-répertoires, sans préfixe numérique initial. Par exemple, un dossier nommé
01-getting-starteddevient un groupe nommé Getting started. - La CLI ignore les fichiers et dossiers commençant par
.ou_, les dossiersnode_modulesetsnippets, ainsi que les chemins listés dans votre fichier.mintignore.
name d’un fichier package.json situé dans le répertoire ou dans son répertoire parent. En l’absence de fichier package.json, la CLI utilise le nom du répertoire. Modifiez le fichier docs.json généré pour personnaliser votre navigation, votre thème et vos couleurs.
Vous devez authentifier la CLI avec votre compte Mintlify pour activer la recherche et l’assistant.
mint login, la CLI stocke vos identifiants dans le gestionnaire d’identifiants de votre système d’exploitation 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 :
--port :
localhost. Pour ouvrir la prévisualisation sur un téléphone ou un autre ordinateur de votre réseau, utilisez le flag --host :
--disable-openapi :
--disable-prefetch :
--groups :
<Visibility for="signed-in">, utilisez le flag --signed-in pour prévisualiser en tant que lecteur connecté sans groupe. Le flag --groups prévisualise également en tant que lecteur connecté.