Markdown

概述

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

原始文件中的所有语法和格式将在翻译后的文件中保持不变。

我们将遵循以下 4 个步骤：

添加您的环境变量

配置您项目的 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

在项目根目录创建一个gt.config.json文件，内容如下：

gt.config.json

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

更改defaultLocale和locales以匹配您项目的语言环境。

如果您的文件是MD文件，您可以使用md键而不是mdx。include键中的字符串数组应该是匹配所有MDX文件的glob模式。

它应该使用[locale]占位符来匹配文件的语言环境。

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

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

package.json

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

这将为您的所有语言环境生成翻译并将它们保存到您的项目中。如果您想将这些文件提交到您的代码库，您可以在提交之前运行此命令。

您已完成！现在，每当您的项目发生变化时，您的项目将自动更新所有Markdown文件。