Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 3.83 KB

README.zh-TW.md

File metadata and controls

113 lines (77 loc) · 3.83 KB
Raw

action-translate-readme

Introduction

Note

v1版本的翻譯器是透過 Linux 第三方套件實現；v2版本是透過 g4f 免費調用 openai api 實現翻譯

  • 我們都知道寫README文檔很費時間,但是現在有一個解決方案可以讓你節省一半的時間. 這就是我們的action-translate-readme

  • 通過 gpt3.5 翻譯不同語言版本的 README

  • 透過 Github Actions(CI/CD) 自動提交(commit、push) 翻譯後的檔案

  • 例如: 撰寫或修改英文版README，自動生成繁體中文、簡體中文、法文...等版本 README

How to use ?

Important

由於 gpt3.5 屬於生成式 AI 模型，因此每次翻譯結果都有機率出現問題，建議使用分支測試，並多嘗試幾次。

Warning

如果你遇到如下錯誤: Error: Input required and not supplied: token，請根據步驟二確定已建立 Token，或者 Token 是否已經過期!

  1. 單擊 ⭐ 圖標將此項目添加到您的 Github 存儲庫 .

  2. 設置你的 Github Token:

    • 創建一個新的 Github Secret Token

      • 設置
      • 開發者設置
      • 個人訪問令牌 - Tokens(classic)
      • 生成新令牌
      • 選擇令牌生命週期 - 建議直接使用無限期
      • 選擇範圍:repo 和 workflow
      • 保留你的secret token(不要丟了,以後需要貼上)

    • 創建一個新的 repository secret

      • 在您的存儲庫中 - settings
      • Securits and variables
      • Actions
      • New repository secret
      • 按token填寫標籤並命名(eg: Action_Bot)

  3. 在目錄 .github/workflows/your_action.yml. 中創建您的操作示例，你可以直接複製以下:

    # .github/workflows/translate.yml
name: Translate Readme

on:
    push:
        branches: ['**']

jobs:
    translate:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v3
              with:
                fetch-depth: 3

            - name: Auto Translate
              uses: Lin-jun-xiang/action-translate-readme@v2 # Based on the tag
              with:
                token: ${{ secrets.Action_Bot }} # Based on step2 name
                g4f_provider: g4f.Provider.DeepAi # You can change this provider
                langs: "en,zh-TW,zh-CN,French,Arabic" # You can define any langs

    在.yml中有三個參數要特別注意:

    • token: 根據步驟2，在repos中建立的token
    • g4f_provider: gpt 的提供者，更多請參考連結
    • langs: 想要產生的語言版本，務必用,分隔不同語言，例如:
      • "en": 僅翻譯英文版
      • "en,zh-TW": 翻譯英文、繁體中文
      • "French,Arabic": 翻譯法文、阿拉伯文

  4. 現在你可以更新 README.md,它會自動生成一個翻譯版本！

Demo

Results of Test Document

  • 查看測試文檔
  • 使用我們的工具更新測試文檔

Back to top