概览

gtx-cli 可用于自动翻译您项目中的 Markdown（MD 与 MDX）文件。

我们将按照以下 4 个步骤进行：

步骤 1：添加环境变量

将生产环境的 API key 和项目 ID 添加到你的环境变量中。 这是使用 gtx-cli 工具所必需的。 你可以在 General Translation 控制台 中获取它们。

GT_API_KEY=<你的 API 密钥>
GT_PROJECT_ID=<你的项目 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 修改为与你项目的 locale 相匹配。

如果你的文件是 MD 文件，可以使用 md 键替代 mdx。include 键中的字符串数组应为用于匹配所有 MDX 文件的 glob 模式。

应使用 [locale] 占位符来匹配文件的 locale。

有关 gt.config.json 文件的更多信息，请参阅配置文档。

步骤 4：在构建流程中添加 gtx-cli translate 命令

在执行构建命令之前，将 gtx-cli translate 添加到你的构建或 CI 流程中，以自动为项目生成并注入翻译。

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <你的构建命令>"
  }
}

这将为你的所有 locales 生成翻译，并将它们保存到你的项目中。 如果你想将这些 files 提交到仓库，可以在提交前先运行此命令。

搞定！现在，每当你的项目发生变化时，项目将自动更新所有 Markdown 文件。

注意

• 你可以使用 gtx-cli translate 命令自动为项目添加翻译。
• 如果你打算提交翻译文件，应在提交前先运行 gtx-cli translate 命令。
• 如需配置翻译的输出路径，请参阅配置文档。

后续步骤

• 查看该 CLI 工具的使用指南。