gpt-translate

项目介绍

🌎 Markdown Translation BOT

Markdown Translation BOT 是一个强大的 GitHub Action 项目，旨在帮助手动翻译繁琐的工作。通过调用多个不同的 AI 模型提供商，该工具可以将用户的 Markdown 文件翻译成多种语言。目前，该项目已超越仅支持 OpenAI，能够与众多 AI 模型提供商进行连接，如 Microsoft Azure、Anthropic 和 Google 等。用户通过该工具可以轻松地将文档转换成不同的语言，以便更广泛地传播信息。

🧐 当前状态

当前，该工具支持翻译 Markdown (.md)、Markdown-JSX (.mdx) 和 JSON (.json) 文件。应注意，只有具有代码库写入权限的用户才能执行翻译命令。这一限定设计是为了防止未经授权的用户对 API 进行滥用。

🔧 设置

仓库设置

为了使用 Markdown Translation BOT，用户需要在其 GitHub 仓库中进行一些设置：

• 前往仓库的 Settings > Actions > General，启用 Read and write permissions 选项，并允许 GitHub Actions 创建和批准合并请求。
• 在 Settings > Secrets and variables > Actions 中设置 API 密钥（如 OPENAI_API_KEY）作为机密。

GitHub Actions 工作流设置

要确保操作顺利进行，用户必须提供 OPENAI_API_KEY 作为 apiKey。另外，为了触发翻译操作，可以在评论中包含 /gpt-translate 或简写 /gt。下面是一个简单的工作流示例：

# .github/workflows/gpt-translate.yml
name: GPT Translate

on:
  issue_comment:
    types: [ created ]

jobs:
  gpt_translate:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Run GPT Translate
        if: |
          contains(github.event.comment.body, '/gpt-translate') || 
          contains(github.event.comment.body, '/gt')
        uses: 3ru/gpt-translate@master
        with:
          apikey: ${{ secrets.OPENAI_API_KEY }}

💡 使用方法

使用 Markdown Translation BOT 的方法简单直观。用户只需在问题或合并请求中创建一个包含 /gpt-translate 或 /gt 的评论。操作执行后，翻译后的文件将被创建为新合并请求或者添加为现有合并请求的新提交。

例如，使用命令 /gpt-translate README.md zh-TW/README.md traditional-chinese，可以将 README.md 文件翻译成繁体中文，并放置在 zh-TW 目录下。

🌐 支持的语言

在理论上，任何由 GPT-4 或 GPT-3.5 理解的语言都能够被该工具支持进行翻译。

🏘️ 社区

我们的社区活跃并开放，用户可以在 GitHub 的 Discussions 中提出问题，也欢迎通过 Issues 来报告错误或建议新功能。

📃 授权协议

该项目采用 MIT 协议进行授权，即用户可以在遵守 MIT 协议的条件下自由使用、复制、修改、合并、发行、发布分发和再授权代码。