Skip to content

Latest commit

 

History

History
112 lines (77 loc) · 3.82 KB

README.zh-CN.md

File metadata and controls

112 lines (77 loc) · 3.82 KB
Raw

action-translate-readme

介绍

Note

v1版本的翻译器是通过 Linux 第三方套件实现；v2版本是通过 g4f 免费调用 openai api 实现翻译

  • 我们都知道写README文档很费时间,但是现在有一个解决方案可以让你节省一半的时间。这就是我们的action-translate-readme

  • 通过 gpt3.5 翻译不同语言版本的 README

  • 通过 Github Actions(CI/CD) 自动提交(commit、push) 翻译后的文件

  • 例如：撰写或修改英文版README，自动生成繁體中文、简体中文、法文...等版本 README

如何使用？

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,它会自动生成一个翻译版本！

演示

#测试文档结果

  • 查看测试文档
  • 使用我们的工具更新测试文档

返回顶部</a