Обзор

gtx-cli можно использовать для автоматического перевода Markdown‑файлов (MD и MDX) вашего проекта.

Мы пройдём 4 шага:

Шаг 1: Добавьте переменные окружения

Добавьте в переменные окружения ваш production API key и project ID. Это необходимо для использования утилиты gtx-cli. Получить их можно в панели управления General Translation.

GT_API_KEY=<ваш ключ API>
GT_PROJECT_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, используйте ключ md вместо mdx. Массив строк в ключе include должен быть glob-шаблоном, который охватывает все ваши файлы MDX.

Используйте плейсхолдер [locale], чтобы сопоставлять локаль файла.

См. раздел configuration для получения дополнительной информации о файле gt.config.json.

Шаг 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.