​
Installation der CLI

Voraussetzung: Bitte installiere Node.js, bevor du fortfährst.
1

CLI installieren.

Führe den folgenden Befehl aus, um die CLI zu installieren:
npm i -g mint
2

Lokal prüfen.

Wechsle in dein Docs-Verzeichnis (wo sich deine docs.json-Datei befindet) und führe den folgenden Befehl aus:
mint dev
Eine lokale Vorschau deiner Dokumentation ist unter http://localhost:3000 verfügbar.
Alternativ kannst du, wenn du die CLI nicht global installieren möchtest, ein einmaliges Skript ausführen: 
npx mint dev

​
Aktualisierungen

Wenn Ihre lokale Vorschau nicht mit der Produktionsversion im Web übereinstimmt, aktualisieren Sie Ihre lokale CLI: 
mint update
Wenn der Befehl mint update in Ihrer lokalen Version nicht verfügbar ist, installieren Sie die CLI in der neuesten Version neu: 
npm i -g mint@latest

​
Benutzerdefinierte Ports

Standardmäßig verwendet die CLI Port 3000. Sie können den Port mit dem Flag --port anpassen. Um die CLI beispielsweise auf Port 3333 auszuführen, verwenden Sie diesen Befehl: 
mint dev --port 3333
Wenn Sie versuchen, einen bereits belegten Port zu verwenden, wird der nächste verfügbare Port genutzt: 
Port 3000 ist bereits belegt. Versuche stattdessen 3001.

​
Als bestimmte Gruppe in der Vorschau

Wenn Sie die Partielle Authentifizierung verwenden, um den Zugriff auf Ihre Dokumentation einzuschränken, können Sie mit dem Flag --group [groupname] als eine bestimmte Authentifizierungsgruppe eine Vorschau anzeigen. Wenn Sie beispielsweise eine Gruppe namens admin haben, können Sie als Mitglied dieser Gruppe mit dem folgenden Befehl eine Vorschau anzeigen: 
mint dev --group admin

​
Zusätzliche Befehle

Auch wenn mint dev der am häufigsten verwendete Befehl ist, gibt es weitere Befehle, mit denen Sie Ihre Dokumentation verwalten können. Die CLI unterstützt Sie beim Validieren von Referenzlinks in Ihrer Dokumentation. Um kaputte Links zu erkennen, verwenden Sie den folgenden Befehl: 
mint broken-links

​
OpenAPI-Spezifikation prüfen

Sie können die CLI verwenden, um Ihre OpenAPI-Datei mit dem folgenden Befehl auf Fehler zu prüfen: 
mint openapi-check <openapiFilenameOrUrl>
Sie können einen Dateinamen (z. B. ./openapi.yaml) oder eine URL (z. B. https://petstore3.swagger.io/api/v3/openapi.json) übergeben.

​
Dateien umbenennen

Sie können Dateien umbenennen und alle Verweise darauf mit dem folgenden Befehl aktualisieren: 
mint rename <oldFilename> <newFilename>

​
Migrieren von MDX-Endpunktseiten

Sie können MDX-Endpunktseiten mit dem folgenden Befehl aus Ihrer OpenAPI-Spezifikation in automatisch generierte Seiten überführen: 
mint migrate-mdx
Dieser Befehl wandelt einzelne MDX-Endpunktseiten in automatisch generierte, in Ihrer docs.json definierte Seiten um, verschiebt MDX-Inhalte in die x-mint-Erweiterung Ihrer OpenAPI-Spezifikation und aktualisiert Ihre Navigation. Weitere Informationen finden Sie unter Migration von MDX.

​
Formatierung

Für die lokale Entwicklung empfehlen wir Erweiterungen in Ihrer IDE, um MDX-Dateien zu erkennen und zu formatieren. Wenn Sie Cursor, Windsurf oder VS Code verwenden, empfehlen wir die MDX VS Code-Erweiterung für Syntaxhervorhebung sowie Prettier für die Codeformatierung. Wenn Sie JetBrains verwenden, empfehlen wir das MDX IntelliJ-IDEA-Plugin für Syntaxhervorhebung und die Einrichtung von Prettier für die Codeformatierung.

​
Fehlerbehebung