Github-Action: 自动生成多语言版本的 README.md

介绍

之前有发布一篇相关文章,但当时并没有将 Action 发布到github marketplace,导致要使用该工具需下载 shell script (现在只要在 yaml 档案写上一个 job 即可)。该专案提供了一个 Github Action 自动翻译功能我们都知道写文档费时费力,但是现在有一个解决方案可以让你节省一半的时间. 这就是我们的action-translate-readme有了这个工具,你可以自动翻译README.md文件,不仅可以翻译,还可以识别Markdown内联代码、表情、代码块、HTML标籤和链接等各种元素其运行原理是通过Github Actions实现自动化,只需要推送更新的README文件,翻译后的README(zh或en)文件即可自动更新(自动提交)

方法

于自己的专案 ./.github/workflow 新增一个 yaml 档案,即可启动 Action:
http://img2.58codes.com/2024/20158150Btbw0tF1Xo.png修改 README.md 时,并 push 至专案上
http://img2.58codes.com/2024/20158150r8fWHTBFAR.pngGithub Action 侦测 README.md 被改动,透过 Action Bot 自动翻译与生成中文文档案 - README.zh-TW.md
http://img2.58codes.com/2024/20158150mJm0YUAIzA.png

目的

相信很多专案开发者,往往会建立多语言版本的说明档 (README.md)。

虽然现在使用浏览器具有强大翻译功能,但是一个 Github 专案上有不同语言的说明档,绝对会让使用者观看得更方便 !
(本人分析自己专案 insight trafic 时,发现中文使用者都会直接观看中文说明档)

结语

目前该专案还有很多不足地方,翻译 Markdown 语言碰上了许多问题,尚有些许地方待更新望各位大佬若觉得哪里要改进,欢迎提出与讨论

更新

使用 g4f 免费调用 openai api 进行翻译,翻译效果好除了繁体中文版,可以自行在.yml定义想要的语言版本,例如: en,zh-TW,zh-CN,French

关于作者: 网站小编

码农网专注IT技术教程资源分享平台,学习资源下载网站,58码农网包含计算机技术、网站程序源码下载、编程技术论坛、互联网资源下载等产品服务,提供原创、优质、完整内容的专业码农交流分享平台。

热门文章