# gt: General Translation CLI tool: Markdown
URL: https://generaltranslation.com/ru/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-ключ и идентификатор проекта.
Это необходимо для использования инструмента `gt`.
Их можно получить в [панели управления General Translation](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, используйте ключ `md` вместо `mdx`.
</Callout>

Измените `defaultLocale` и `locales` в соответствии с локалями вашего проекта.

Массив строк в ключе `include` должен содержать glob-шаблон, который охватывает все ваши MDX-файлы.

В нём нужно использовать заполнитель `[locale]`, чтобы он соответствовал локали файла.

Подробнее о файле `gt.config.json` см. в документации по [конфигурации](/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>"
  }
}
```

Это сгенерирует переводы для всех ваших локалей и сохранит их в проекте.
Если вы хотите закоммитить эти файлы в репозиторий, вместо этого перед коммитом выполните следующую команду.

Готово! Теперь проект будет автоматически обновлять все ваши Markdown-файлы при любых изменениях в проекте.

***


## Примечания

* Вы можете автоматически добавлять переводы в свой проект с помощью команды [`gt translate`](/docs/cli/translate).
* Если вы хотите сохранять файлы переводов в коммитах, запускайте команду `gt translate` перед коммитом.
* Чтобы настроить путь вывода для переводов, см. документацию по [конфигурации](/docs/cli/reference/config).

## Что делать дальше

* См. [команду `gt translate`](/docs/cli/translate), чтобы узнать подробнее об использовании CLI.