Mintlify : prévisualiser la doc en local avec le CLI mint

À qui cela s'adresse

Si vous maintenez de la documentation Mintlify et voulez voir l’effet sur cette machine avant de pousser en ligne, ce dépôt officiel de doc convient. C’est Official Mintlify documentation. Le dépôt est

https://github.com/mintlify/docs

Le site de doc publié est

https://mintlify.com/docs

Le paquet CLI est

https://www.npmjs.com/package/mint

Un meilleur profil a déjà un répertoire de doc avec docs.json (ce dépôt cloné, ou votre projet Mintlify), peut exécuter npm sur cette machine, et n’accepte que cette commande d’installation officielle : npm i -g mint. C’est un CLI global, pas un paquet de marché de skills ; ne le réécrivez pas en skills add.

Si vous voulez seulement lire dans un navigateur

https://mintlify.com/docs

et ne prévoyez ni de modifier la doc ni d’ouvrir un aperçu local, le CLI est inutile. La première fois, faites seulement l’aperçu local. N’exécutez pas une commande de mise en ligne absente de cette page. Cette page ne nomme aucun client de programmation ; voyez l’aperçu dans le navigateur.

Premier essai en 3 minutes

N’utiliser que ce chemin d’installation officiel :

npm i -g mint

Une installation globale change la ligne de commande de cette machine. Confirmez d’abord que vous acceptez un paquet global. Ne cherchez pas de plugin ni de marché.

Prérequis : Node/npm est installé ; le répertoire de travail actuel est la racine de doc, la couche où docs.json est visible. Si le fichier n’existe pas encore, clonez d’abord le dépôt officiel de doc. N’inventez pas un docs.json dans un format non documenté.

Puis exécutez à cette racine :

mint dev

Cela démarre un aperçu local et est un processus local. Confirmez que le port n’est accessible qu’en local, puis exécutez. Ouvrez l’adresse locale affichée dans le navigateur et vérifiez qu’une page de doc s’affiche.

Signal de succès : la commande mint fonctionne, et après mint dev vous voyez dans le navigateur un arbre de doc correspondant à docs.json, et non une erreur d’absence de docs.json. S’il dit que vous n’êtes pas à la racine de doc, cd vers le répertoire qui contient docs.json et relancez ; n’ajoutez pas d’arguments non documentés. Si mint n’existe pas, revenez à npm i -g mint ; ne changez pas pour un nom de paquet non écrit.

Cas d’usage

Cas 1 : installer Mint CLI. Officiellement installer avec npm i -g mint pour prévisualiser les changements de doc en local. Après installation, exécutez mint dans le terminal et confirmez que la commande est dans PATH. C’est un effet de bord global ; ne l’installez pas à l’aveugle dans un environnement non fiable. Cette page n’écrit ni numéro de version ni substitut npx mint ; s’ils manquent, n’utiliser que cette installation globale.

Cas 2 : prévisualiser à la racine de doc. Officiellement exécuter mint dev à la racine de doc (là où est docs.json). Changez le titre ou un paragraphe d’une page md existante, enregistrez, et voyez si l’aperçu local se met à jour. Ne faites pas de poussée de mise en ligne au premier essai. Cette page n’écrit ni le détail du rechargement à chaud ni un port par défaut ; prenez l’adresse d’aperçu dans la sortie de ligne de commande, ne devinez pas.

Limites

C’est le dépôt officiel de doc plus l’aperçu CLI, pas un générateur de site statique générique. Sans docs.json, mint dev n’a pas de point de départ officiel.

L’installation officielle n’est que npm i -g mint. mint dev est l’aperçu, pas un second installateur. N’inventez pas une installation de marché de skills. Le site publié est une référence en lecture seule, pas une source d’installation.

Le paquet global et le démarrage de dev ont des effets de bord. Confirmez d’abord le répertoire. Cette page ne donne pas d’étapes de déploiement, d’hébergement ou de domaine personnalisé ; n’exécutez pas d’actions de mise en ligne non écrites. Elle n’énumère pas non plus les autres sous-commandes de mint ; ne devinez pas les commandes qui n’apparaissent jamais.