Mintlify: Dokumentation lokal mit der mint-CLI vorschauen

Für wen

Wenn Sie Mintlify-Dokumentation pflegen und Änderungen zuerst auf diesem Rechner sehen wollen statt sie direkt live zu schieben, passt dieses offizielle Dokumentationsrepository. Es ist Official Mintlify documentation. Das Repository ist

https://github.com/mintlify/docs

Die veröffentlichte Dokumentationssite ist

https://mintlify.com/docs

Das CLI-Paket ist

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

Besser geeignet ist, wer bereits ein Dokumentationsverzeichnis mit docs.json hat (dieses geklonte Repository oder ein eigenes Mintlify-Projekt), auf diesem Rechner npm ausführen kann und nur diesen offiziellen Installationsbefehl akzeptiert: npm i -g mint. Das ist eine globale CLI, kein Skill-Markt-Paket; nicht in skills add umschreiben.

Wenn Sie nur im Browser lesen wollen

https://mintlify.com/docs

und weder Docs ändern noch eine lokale Vorschau starten, brauchen Sie die CLI nicht. Beim ersten Mal nur lokale Vorschau. Keinen Go-live-Befehl ausführen, der auf dieser Seite nicht vorkommt. Diese Seite nennt keinen Programmierclient; die Vorschau im Browser ansehen.

Erster Versuch in 3 Minuten

Nur diesen offiziellen Installationsweg verwenden:

npm i -g mint

Eine globale Installation ändert die Kommandozeile dieses Rechners. Zuerst bestätigen, dass Sie ein globales Paket akzeptieren. Kein Plugin und keinen Markt suchen.

Voraussetzungen: Node/npm ist installiert; das aktuelle Arbeitsverzeichnis ist der Dokumentenstamm, also die Ebene, auf der docs.json sichtbar ist. Fehlt die Datei noch, zuerst das offizielle Dokumentationsrepository klonen. Kein docs.json in undokumentiertem Format erfinden.

Dann in diesem Stamm ausführen:

mint dev

Das startet eine lokale Vorschau und ist ein lokaler Prozess. Bestätigen, dass der Port nur lokal erreichbar ist, dann ausführen. Die ausgegebene lokale Adresse im Browser öffnen und prüfen, ob eine Dokumentseite gerendert wird.

Erfolgssignal: der Befehl mint funktioniert, und nach mint dev sehen Sie im Browser einen zu docs.json passenden Dokumentenbaum statt einer Meldung, docs.json fehle. Heißt es, Sie seien nicht im Dokumentenstamm, mit cd in das Verzeichnis mit docs.json wechseln und erneut laufen; keine undokumentierten Parameter hinzufügen. Existiert mint nicht, zu npm i -g mint zurück; keinen ungeschriebenen Paketnamen wählen.

Anwendungsbeispiele

Beispiel 1: Mint CLI installieren. Offiziell mit npm i -g mint installieren, um Dokumentationsänderungen lokal vorzuschauen. Nach der Installation mint im Terminal ausführen und bestätigen, dass der Befehl auf PATH liegt. Das ist eine globale Nebenwirkung; nicht in einer unvertrauten Umgebung wahllos installieren. Diese Seite schreibt keine Versionsnummer und keinen Ersatz npx mint; fehlt das, nur diese globale Installation verwenden.

Beispiel 2: am Dokumentenstamm vorschauen. Offiziell mint dev am Dokumentenstamm ausführen (dort wo docs.json liegt). Titel oder Absatz einer vorhandenen md-Seite ändern, speichern und prüfen, ob die lokale Vorschau nachzieht. Beim ersten Versuch keinen Go-live-Push. Diese Seite schreibt weder Hot-Reload-Details noch einen Standardport; die Vorschaadresse aus der Kommandozeilenausgabe nehmen, nicht raten.

Grenzen

Dies ist das offizielle Dokumentationsrepository plus CLI-Vorschau, kein generischer Static-Site-Generator. Ohne docs.json hat mint dev keinen offiziellen Startpunkt.

Offizielle Installation ist nur npm i -g mint. mint dev ist Vorschau, kein zweiter Installer. Keine Skill-Markt-Installation erfinden. Die veröffentlichte Site ist eine schreibgeschützte Referenz, keine Installationsquelle.

Globales Paket und Dev-Start haben Nebenwirkungen. Zuerst das Verzeichnis bestätigen. Diese Seite gibt keine Schritte zu Bereitstellung, Hosting oder eigener Domain; ungeschriebene Go-live-Aktionen nicht ausführen. Andere Unterbefehle von mint sind nicht aufgeführt; nicht erschienene Befehle nicht raten.