Übersicht

Mit gtx-cli können die Markdown‑Dateien (MD und MDX) Ihres Projekts automatisch übersetzt werden.

Wir gehen in 4 Schritten vor:

Schritt 1: Umgebungsvariablen hinzufügen

Fügen Sie Ihren API-Schlüssel für die Produktion und Ihre Projekt-ID zu Ihren Umgebungsvariablen hinzu. Das ist erforderlich, um das Tool gtx-cli zu verwenden. Sie erhalten beides im General Translation Dashboard.

GT_API_KEY=<dein-api-key>
GT_PROJECT_ID=<deine-projekt-id>

Schritt 2: gtx-cli installieren

Installiere das CLI-Tool gtx-cli in deinem Projekt.

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Schritt 3: Konfiguriere die gt.config.json-Datei deines Projekts

Erstelle im Stammverzeichnis deines Projekts eine gt.config.json-Datei mit folgendem Inhalt:

{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "mdx": {
      "include": ["docs/[locale]/**/*.mdx"]
    }
  }
}

Ändern Sie defaultLocale und locales, damit sie den locales Ihres Projekts entsprechen.

Wenn Ihre Dateien MD-Dateien sind, können Sie den Schlüssel md statt mdx verwenden. Das Zeichenketten‑Array im Schlüssel include sollte ein Glob‑Muster sein, das all Ihre MDX‑Dateien erfasst.

Es sollte den Platzhalter [locale] verwenden, um die locale der Datei abzubilden.

Weitere Informationen zur Datei gt.config.json finden Sie in der Dokumentation zur Konfiguration.

Schritt 4: Fügen Sie den Befehl gtx-cli translate zu Ihrem Build-Prozess hinzu

Fügen Sie den Befehl gtx-cli translate in Ihrem Build- oder CI-Prozess vor dem Build-Befehl aus, um Übersetzungen automatisch in Ihr Projekt zu integrieren.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <Ihr Build-Befehl>"
  }
}

Dadurch werden Übersetzungen für alle deine locales generiert und in deinem Projekt gespeichert. Wenn du diese files in dein Repo übernehmen möchtest, kannst du stattdessen vor dem Commit diesen Befehl ausführen.

Fertig! Dein Projekt aktualisiert nun automatisch alle deine Markdown-Dateien, sobald sich etwas am Projekt ändert.

Hinweise

• Mit dem Befehl gtx-cli translate können Sie Übersetzungen automatisch zu Ihrem Projekt hinzufügen.
• Wenn Sie Ihre Übersetzungsdateien committen möchten, sollten Sie den Befehl gtx-cli translate vor dem Commit ausführen.
• Wie Sie den Ausgabepfad für Ihre Übersetzungen konfigurieren, finden Sie in der Konfigurationsdokumentation.

Nächste Schritte

• Siehe die Anwendungsanleitung für das CLI-Tool.