Markdown

General Translationを使用してプロジェクトのMarkdownファイルの自動翻訳を設定する方法

概要

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

元のファイルに含まれるすべての構文や書式設定は、翻訳後のファイルでも保持されます。

次の4つのステップに従います：

環境変数を追加します

gtx-cli をインストールします

プロジェクトの gt.config.json ファイルを設定します

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

.env

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

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

npm i --save-dev gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

プロジェクトのルートに 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 ファイルの詳細については、設定ドキュメントを参照してください。

gtx-cli translate コマンドをビルドやCIプロセスのビルドコマンドの前に追加することで、自動的にプロジェクトに翻訳を追加できます。

package.json

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

これにより、すべてのロケールの翻訳が生成され、プロジェクトに保存されます。これらのファイルをリポジトリにコミットしたい場合は、コミット前にこのコマンドを実行することもできます。

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