# gt: General Translation CLI tool: Markdown
URL: https://generaltranslation.com/ja/docs/cli/formats/mdx.mdx
---
title: Markdown
description: General Translation を使用して、プロジェクトの Markdown ファイルの自動翻訳を設定する方法
---

## 概要

`gt` を使用すると、プロジェクトの Markdown (MD および MDX) ファイルを自動的に翻訳できます。

<Callout type="info">
  元のファイルに含まれるすべての構文と書式は、翻訳後のファイルでも保持されます。
</Callout>

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

<Steps>
  <Step>
    環境変数を追加する
  </Step>

  <Step>
    [`gt`](/docs/cli) をインストールする
  </Step>

  <Step>
    プロジェクトの [`gt.config.json`](/docs/cli/reference/config) ファイルを設定する
  </Step>

  <Step>
    [`gt translate`](/docs/cli/translate#translate) を実行する
  </Step>
</Steps>

***

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

本番用のAPIキーとプロジェクトIDを環境変数に追加します。
これは `gt` ツールを使用するために必要です。
これらの情報は [General Translation dashboard](https://generaltranslation.com/dashboard) で確認できます。

```bash title=".env"
GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>
```


## ステップ2: `gt` をインストールする

プロジェクトに `gt` ツールをインストールします。

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm i gt
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add --dev gt
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add --dev gt
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add --save-dev gt
    ```
  </Tab>
</Tabs>

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

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

```json title="gt.config.json"
{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "mdx": {
      "include": ["docs/[locale]/**/*.mdx"]
    }
  }
}
```

<Callout type="info">
  ファイルが MD の場合は、`mdx` の代わりに `md` キーを使用できます。
</Callout>

`defaultLocale` と `locales` は、プロジェクトで使用するロケールに合わせて変更してください。

`include` キーの文字列配列には、すべての MDX ファイルに一致する glob パターンを指定する必要があります。

ファイルのロケールに一致させるには、`[locale]` プレースホルダーを使用してください。

`gt.config.json` ファイルの詳細については、[configuration](/docs/cli/reference/config) のドキュメントを参照してください。


## ステップ 4: `gt translate` コマンドをビルドプロセスに追加する

プロジェクトに翻訳を自動的に追加するには、ビルドコマンドの前に `gt translate` コマンドをビルドまたは CI プロセスへ追加します。

```json title="package.json"
{
  "scripts": {
    "translate": "npx gt translate",
    "build": "npm run translate && <your build command>"
  }
}
```

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

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

***


## 注意

* [`gt translate`](/docs/cli/translate) コマンドを使うと、翻訳をプロジェクトに自動で追加できます。
* 翻訳ファイルをコミットする場合は、コミット前に `gt translate` コマンドを実行してください。
* 翻訳の出力パスを設定するには、[configuration](/docs/cli/reference/config) ドキュメントを参照してください。

## 次のステップ

* CLI での使用方法の詳細については、[translate コマンド](/docs/cli/translate)を参照してください。