Überblick

gtx-cli kann verwendet werden, um die JavaScript- (js) und TypeScript- (ts) Dateien Ihres Projekts automatisch zu übersetzen.

Wir gehen in 4 Schritten vor:

Schritt 1: Umgebungsvariablen hinzufügen

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

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

Schritt 2: gtx-cli installieren

Installieren Sie das Tool gtx-cli in Ihrem 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 Projektstammverzeichnis eine gt.config.json-Datei mit folgendem Inhalt:

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

Ändern Sie defaultLocale und locales, damit sie zu den Locales Ihres Projekts passen.

Wenn Ihre Dateien JavaScript-Dateien sind, können Sie den Schlüssel js statt ts verwenden. Das Zeichenkettenarray im Schlüssel include sollte ein Glob-Muster sein, das alle Ihre JS-Dateien abdeckt.

Verwenden Sie den Platzhalter [locale], um die Locale der Datei zuzuordnen.

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

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

Hinweise

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

Nächste Schritte

• Siehe den Nutzungsleitfaden für die CLI.