マークダウン

一般翻訳を使用してプロジェクトのマークダウンファイルの自動翻訳を設定する方法

概要

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

プロジェクトのルートに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ファイルが自動的に更新されます。