Markdown

如何使用 General Translation 为您的项目 Markdown 文件设置自动翻译

概述

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

原文件中的所有语法和格式将在翻译后的文件中被保留。

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

添加你的环境变量

配置你项目的 gt.config.json 文件

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

.env

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

在你的项目中安装 gtx-cli 工具。

npm i --save-dev gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

在你的项目根目录下创建一个 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] 占位符来匹配文件的语言。

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

在构建或 CI 流程中，在构建命令之前添加 gtx-cli translate 命令，以便自动为你的项目添加翻译。

package.json

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

这将为你所有的语言环境生成翻译，并将其保存到你的项目中。如果你希望将这些文件提交到你的仓库，可以在提交之前运行此命令。

你已经完成了！现在，每当你的项目发生变化时，所有的 Markdown 文件都会自动更新翻译。