Markdown

Übersicht

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

Wir folgen diesen 4 Schritten:

Schritt 1: Fügen Sie Ihre Umgebungsvariablen hinzu

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

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

Schritt 2: Installiere gtx-cli

Installiere das Tool gtx-cli in deinem Projekt.

npm i --save-dev gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Schritt 3: Konfigurieren Sie die Datei gt.config.json Ihres Projekts

Erstellen Sie eine Datei namens gt.config.json im Root-Verzeichnis Ihres Projekts mit folgendem Inhalt:

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

Passen Sie defaultLocale und locales so an, dass sie den Sprachversionen Ihres Projekts entsprechen.

Wenn Ihre Dateien MD-Dateien sind, können Sie den Schlüssel md anstelle von mdx verwenden. Das String-Array im Schlüssel include sollte ein Glob-Muster sein, das alle Ihre MDX-Dateien abdeckt.

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

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

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

Fügen Sie den Befehl gtx-cli translate zu Ihrem Build- oder CI-Prozess hinzu, bevor Sie den Build-Befehl ausführen, um automatisch Übersetzungen zu Ihrem Projekt hinzuzufügen.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <your build command>"
  }
}

Dadurch werden Übersetzungen für alle Ihre Sprachversionen generiert und in Ihrem Projekt gespeichert. Wenn Sie diese Dateien in Ihr Repository einchecken möchten, können Sie stattdessen diesen Befehl vor dem Commit ausführen.

Fertig! Ihr Projekt wird nun automatisch alle Ihre Markdown-Dateien aktualisieren, sobald sich Ihr Projekt ändert.

Hinweise

• Sie können Übersetzungen automatisch zu Ihrem Projekt hinzufügen mit dem Befehl gtx-cli translate.
• Wenn Sie Ihre Übersetzungsdateien committen möchten, sollten Sie den Befehl gtx-cli translate vor dem Commit ausführen.
• Um den Ausgabepfad für Ihre Übersetzungen zu konfigurieren, siehe die Konfigurations- Dokumentation.

Nächste Schritte

• Siehe den Nutzungsleitfaden für das CLI-Tool.