Mintlify

Was ist Mintlify?

Mintlify ist eine Dokumentationsplattform, die schöne, anpassbare Dokumentationsseiten erstellt. Sie bietet integrierte Such-, Analyse- und API-Playground-Funktionen zum Erstellen moderner Entwicklerdokumentation.

Was ist Lingo.dev CLI?

Lingo.dev ist eine KI-gestützte Übersetzungsplattform. Die Lingo.dev CLI liest Quelldateien, sendet übersetzbare Inhalte an große Sprachmodelle und schreibt übersetzte Dateien zurück in Ihr Projekt.

Über diese Anleitung

Diese Anleitung erklärt, wie Sie Lingo.dev CLI in einer Mintlify-Dokumentationsseite einrichten. Sie erfahren, wie Sie ein Projekt mit Mintlify erstellen, eine Übersetzungspipeline konfigurieren und die Ergebnisse anzeigen.

Schritt 1. Mintlify-Projekt einrichten

1. Installieren Sie die Mintlify CLI:

   npm i -g mint
   

2. Klonen Sie die Mintlify-Starter-Vorlage:

   git clone https://github.com/mintlify/starter.git
   

3. Navigieren Sie in das Projektverzeichnis:

   cd starter
   

Schritt 2. Quellinhalte erstellen

1. Erstellen Sie ein Verzeichnis zum Speichern der Dokumentation in der Quellsprache:

   mkdir en
   

2. Erstellen Sie eine Datei, die Dokumentationsinhalte enthält (z. B. en/overview.mdx):

   ---
   title: "Introduction"
   description: "Welcome to the new home for your documentation"
   ---
   
   ## Getting started
   
   This documentation is automatically translated by Lingo.dev.
   
   ## Features
   
   Our product includes powerful capabilities for modern development.
   

Schritt 3. CLI konfigurieren

Erstellen Sie im Stammverzeichnis des Projekts eine Datei i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "mdx": {
      "include": ["[locale]/*.mdx", "[locale]/*/*.mdx"]
    }
  }
}

Diese Datei definiert:

• die Dateien, die Lingo.dev CLI übersetzen soll
• die Sprachen, zwischen denen übersetzt werden soll

In diesem Fall übersetzt die Konfiguration MDX-Dateien von Englisch nach Spanisch.

Es ist wichtig zu beachten, dass:

• [locale] ein Platzhalter ist, der zur Laufzeit ersetzt wird. Er stellt sicher, dass Inhalte von einem Speicherort gelesen (z. B. en/index.mdx) und an einen anderen Speicherort geschrieben werden (z. B. es/index.mdx).
• Lingo.dev CLI unterstützt keine rekursiven Glob-Muster (z. B. **/*.mdx). Sie müssen zusätzliche includeMuster erstellen, um Dateien zu übersetzen, die sich in verschachtelten Verzeichnissen befinden.

Weitere Informationen finden Sie unter i18n.json-Konfiguration.

Schritt 4. Inhalte übersetzen

1. Registrieren Sie sich für ein Lingo.dev-Konto.

2. Melden Sie sich über die CLI bei Lingo.dev an:

   npx lingo.dev@latest login
   

3. Führen Sie die Übersetzungs-Pipeline aus:

   npx lingo.dev@latest run
   

   Die CLI erstellt ein es/Verzeichnis zum Speichern der übersetzten Inhalte und eine i18n.lockDatei, um nachzuverfolgen, was übersetzt wurde (um unnötige erneute Übersetzungen zu vermeiden).

Schritt 5. Übersetzungen verwenden

1. Fügen Sie in der docs.jsonDatei eine languagesEigenschaft zum navigationObjekt hinzu:

   {
     "navigation": {
       "languages": []
     }
   }
   

2. Fügen Sie für jede unterstützte Sprache ein separates Objekt zum Array hinzu:

   {
     "navigation": {
       "languages": [
         {
           "language": "en",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["en/overview"]
             }
           ]
         },
         {
           "language": "es",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["es/overview"]
             }
           ]
         }
       ]
     }
   }
   

   Beachten Sie, dass:

   • Sie die gesamte Navigationsstruktur für jede Sprache separat replizieren müssen.
   • Mintlify nur eine Teilmenge der Sprachen unterstützt, die Lingo.dev CLI unterstützt.

3. Starten Sie den Entwicklungsserver:

   mint dev
   

4. Navigieren Sie zu http://localhost:3000. Sie sollten ein Dropdown-Menü zum Wechseln zwischen Sprachen sehen.

Bekannte Einschränkungen

• Jeglicher UI-Text, der in der docs.jsonDatei definiert ist (z. B. Sidebar-Gruppenbeschriftungen, Suchfeld-Platzhaltertext usw.), wird nicht übersetzt.

Unterstützte Sprachen

Mintlify unterstützt nur eine Teilmenge der Sprachen, die Lingo.dev CLI unterstützt. Die aktuellste Liste finden Sie in der offiziellen Dokumentation.