Markdown

Überblick

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

Wir werden diese 4 Schritte befolgen:

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 vom General Translation Dashboard.

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

Schritt 2: Installiere gtx-cli

Installiere das gtx-cli Tool in deinem Projekt.

npm i --save-dev gtx-cli

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

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

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

Ändern Sie defaultLocale und locales entsprechend den Sprachen Ihres Projekts.

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 erfasst.

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

Weitere Informationen zur gt.config.json-Datei 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 vor dem Build-Befehl hinzu, um automatisch Übersetzungen zu Ihrem Projekt hinzuzufügen.

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

Dies generiert Übersetzungen für alle Ihre Sprachen und speichert sie in Ihrem Projekt. Wenn Sie diese Dateien in Ihr Repository übernehmen möchten, können Sie diesen Befehl stattdessen vor dem Commit ausführen.

Sie sind fertig! Jetzt wird Ihr Projekt automatisch alle Ihre Markdown-Dateien aktualisieren, wenn sich Ihr Projekt ändert.

Anmerkungen

• Sie können Ihrem Projekt automatisch Übersetzungen 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 Konfigurationsdokumentation.

Nächste Schritte

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