Overview

gtx-cli can be used to automatically translate your project’s Markdown (MD and MDX) files.

We’ll follow these four steps:

Step 1: Add your environment variables

Add your production API key and project ID to your environment variables. This is necessary to use the gtx-cli tool. You can obtain these from the General Translation dashboard.

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

Step 2: Install gtx-cli

Install the gtx-cli tool in your project.

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Step 3: Configure your project’s gt.config.json file

Create a gt.config.json file in the root of your project with the following content:

{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "mdx": {
      "include": ["docs/[locale]/**/*.mdx"]
    }
  }
}

Change the defaultLocale and locales to match your project’s locales.

If your files are MD files, you can use the md key instead of mdx. The string array in the include key should be a glob pattern that matches all your MDX files.

It should use the [locale] placeholder to match the file’s locale.

See the configuration docs for more information on the gt.config.json file.

Step 4: Add the gtx-cli translate command to your build process

Add the gtx-cli translate command to your build or CI process before the build step to automatically add translations to your project.

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

This will generate translations for all your locales and save them to your project. If you want to commit these files to your repo, you can instead run this command before committing.

You’re done! Your project will now automatically update all your Markdown files whenever your project changes.

Notes

• You can automatically add translations to your project with the gtx-cli translate command.
• If you plan to commit your translation files, run the gtx-cli translate command before committing.
• To configure the output path for your translations, see the configuration docs.

Next steps

• See the usage guide for the CLI tool.