README.zh-TW.md

🌎 Markdown 翻譯機器人

English | 简体中文 | 繁體中文 | Español | हिंदी, हिन्दी | 한국어 | 日本語

這個 GitHub Action 使用多個 AI 模型將你的 Markdown 文件翻譯成多種語言。

Important

現在可用：來自多個提供商的 AI 模型✨
我們已經擴展到支持多個 AI 模型提供商。
有關支持的提供商的完整列表和詳細信息，請參閱我們的發佈說明。

🧐 當前狀態

• 此 Action 僅支持翻譯 markdown(.md)、markdown-jsx(.mdx)、json(.json) 文件。

• 只有擁有 倉庫寫入權限 的人才能執行此命令。

這些限制防止了非信任方濫用 API。

🔧 設置

倉庫設置

1. 設置 > Actions > 一般

• 啟用 讀取和寫入權限
• 啟用 允許 GitHub Actions 創建和批准拉取請求

2. 設置 > Secrets 和變量 > Actions

• 將 你的 API 密鑰(OPENAI_API_KEY) 設置為 secrets

GitHub Actions 工作流程設置

必需

• 提供 OPENAI_API_KEY 作為 apiKey。
• 設置 on 以在創建評論時觸發 (types: [ created ])。
• 預先檢出(actions/checkout@v3)。

推薦 (以最小化不必要的運行時間)

• 配置僅在評論中包含 /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 }}

💡 使用方法

/gpt-translate [輸入文件路徑] [輸出文件路徑] [目標語言] 

你可以使用 /gt 作為 /gpt-translate 的簡寫。

1. 在問題或拉取請求中創建一個包含 /gpt-translate 或 /gt 的評論。

2.【在問題中】翻譯後的文件將被創建為 拉取請求。

2.【在拉取請求中】翻譯後的文件將 以新提交的形式添加到拉取請求中。

換句話說，如果你不斷在問題中評論，新的 PR 將不斷被創建。 如果你不斷在 PR 中評論，新的提交將不斷被添加到該 PR 中。

📝 示例

/gpt-translate README.md zh-TW/README.md traditional-chinese

將 README.md 翻譯成繁體中文並放置在 zh-TW 目錄下。

多文件支持

你可以通過在輸入文件路徑中指定通配符來一次翻譯多個文件。

這裡有一個示例

/gpt-translate *.md *.ja.md Japanese

如果根目錄中有 A.md 和 B.md，輸出將是 A.ja.md 和 B.ja.md。文件名繼承自輸入文件。 我正在考慮以任意文件名輸出文件，但如果你有聰明的想法，請通過問題提出建議！

有關更多信息，請參閱網站

🌐 支持的語言

任何由 GPT-4 或 GPT-3.5 解釋的語言

🏘️ 社區

• 討論
  • 如果你有任何問題，請隨時在 GitHub 討論中提問 :)
• 問題
  • 請將錯誤和新功能建議提交到 GitHub 問題

📃 許可證

MIT 許可證