Überblick

gtx-cli kann verwendet werden, um die Markdown-Dateien (MD und MDX) Ihres Projekts automatisch zu übersetzen.

Wir folgen diesen 4 Schritten:

Schritt 1: Umgebungsvariablen hinzufügen

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

GT_API_KEY=<Ihr-API-Schlüssel>
GT_PROJECT_ID=<Ihre-Projekt-ID>

Schritt 2: gtx-cli installieren

Installiere das 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: Konfigurieren Sie die gt.config.json-Datei Ihres Projekts

Erstellen Sie im Projektstammverzeichnis 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 zu den Locales Ihres Projekts passen.

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 alle Ihre MDX-Dateien erfasst.

Es sollte den Platzhalter [locale] verwenden, um mit der Locale der Datei übereinzustimmen.

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 vor dem Build-Befehl in Ihren Build- oder CI-Prozess ein, um Übersetzungen automatisch zu Ihrem Projekt hinzuzufügen.

{
  "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 committen möchtest, kannst du stattdessen diesen Befehl vor dem Commit ausführen.

Fertig! Jetzt aktualisiert dein Projekt automatisch all deine Markdown files, sobald sich dein Projekt ändert.

Hinweise

• Sie können Ihrem Projekt automatisch Übersetzungen mit dem Befehl gtx-cli translate hinzufügen.
• Wenn Sie Ihre Übersetzungsdateien committen möchten, sollten Sie den Befehl gtx-cli translate vor dem Commit ausführen.
• Informationen zum Konfigurieren des Ausgabepfads für Ihre Übersetzungen finden Sie in der Konfigurations-Dokumentation.

Nächste Schritte

• Siehe den Leitfaden zur Verwendung des CLI-Tools.