概要

gtx-cli を使うと、プロジェクトの Markdown（MD/MDX）ファイルを自動翻訳できます。

次の4つの手順で進めます:

ステップ 1: 環境変数を追加する

本番用のAPIキーとプロジェクトIDを環境変数に追加します。 これは gtx-cli ツールを利用するために必要です。 これらは General Translation のダッシュボード から取得できます。

GT_API_KEY=<API キー>
GT_PROJECT_ID=<プロジェクト ID>

ステップ 2: gtx-cli のインストール

プロジェクトに gtx-cli ツールをインストールします。

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

ステップ 3: プロジェクトの gt.config.json ファイルを設定する

プロジェクトのルートに gt.config.json ファイルを作成し、次の内容を記述します:

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

プロジェクトの対応ロケールに合わせて defaultLocale と locales を設定してください。

ファイルが MD の場合は、mdx の代わりに md キーを使えます。include キーの文字列配列は、すべての MDX ファイルに一致するグロブパターンにしてください。

ファイルのロケールに対応させるために、[locale] プレースホルダーを使用してください。

gt.config.json についての詳細は、configuration ドキュメントを参照してください。

ステップ4：ビルドプロセスに gtx-cli translate コマンドを追加する

翻訳を自動的にプロジェクトへ反映するため、ビルドコマンドの前に gtx-cli translate コマンドをビルドまたは CI のプロセスに追加してください。

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <任意のビルドコマンド>"
  }
}

これにより、すべての対応ロケール向けの翻訳が生成され、プロジェクトに保存されます。 これらのファイルをリポジトリにコミットしたい場合は、コミット前に代わりに次のコマンドを実行してください。

完了です！これで、プロジェクトに変更があるたびに、すべての Markdown ファイルが自動的に更新されます。

注意事項

• gtx-cli translate コマンドを使うと、プロジェクトに翻訳を自動的に追加できます。
• 翻訳ファイルをコミットする場合は、コミット前に gtx-cli translate コマンドを実行してください。
• 翻訳の出力パスを設定するには、設定 ドキュメントを参照してください。

次のステップ

• CLI ツールの使用方法ガイドをご覧ください。