Auto i18n

Auto-i18n：使用ChatGPT 的自動多語言翻譯工具

Auto-i18n 是一個使用ChatGPT 自動將Markdown 文件批量翻譯為多語言的工具。它實現了博客文章i18n(Internationalization) 的全自動化。你僅需將博文推送至GitHub 倉庫，即可藉助GitHub Actions 實現自動轉譯為多種語言。 （目前支持英語、西班牙語和阿拉伯語，後續將提供更多語言支持）

Auto-i18n 的主要特性：

• 批量多語言翻譯：Auto-i18n 提供了批量翻譯的功能，使你能夠將一整個路徑下的所有Markdown 文檔一次性翻譯多語言，極大地提高了多語言化項目的效率。
• 兼容Front Matter ：Auto-i18n 兼容Markdown Front Matter 語法，你可以自定義不同字段的翻譯或替換規則。
• 固定內容替換：Auto-i18n 還支持固定內容替換。如果你希望文檔中一些重複字段的譯文保持不變，這個功能可以幫助你實現文檔的一致性。
• 自動化工作流：你可以使用GitHub Actions 實現自動化的翻譯流程"。。無需手動干預，翻譯工作會自動進行並更新文檔，使你能夠更專注於內容。

快速上手

1. 將倉庫克隆到本地，把env_template.py重命名為env.py ，並提供你的ChatGPT API。如果你沒有自己的API，可以到GPT_API_free 申請到一個免費的；也可以藉助go-chatgpt-api 把網頁版ChatGPT 轉API 使用。
2. 安裝必需的模塊： pip install -r requirements.txt 。
3. 執行命令python auto-translater.py運行程序，它將會自動處理測試目錄testdir/to-translate下的所有Markdown 文件，批量翻譯為英語、西班牙語、阿拉伯語。 （後續將提供更多語言支持）

詳細描述

程序auto-translater.py的運行邏輯如下：

1. 程序將自動處理測試目錄testdir/to-translate下的所有Markdown 文件，你可以在exclude_list變量中排除不需要翻譯的文件。
2. 處理後的文件名會被記錄在自動生成的processed_list.txt中。下次運行程序時，已處理的文件將不會再次翻譯。
3. 對於原本使用英文撰寫的文章，程序不會重新翻譯成英文，也不會翻譯回中文，而會翻譯為其他語言。你需要在> This post was originally written in English. （注意在上下各留一個空行），以便程序識別。請參考測試文章_en.md。
4. 如果需要重新翻譯指定文章（例如，翻譯結果不准確，或文章內容髮生更改等），你可以在文章中加入字段[translate] （同樣需要在上下各留一個空行）。這將會忽略exclude_list和processed_list的規則，強制進行翻譯處理。請參考測試文章_force-mark.md。
5. 如果Markdown 文件中包含Front Matter，將按照程序內的規則front_matter_translation_rules選擇以下處理方式：
   1. 自動翻譯：由ChatGPT 翻譯。適用於文章標題或文章描述字段。
   2. 固定字段替換：適用於分類或標籤字段。例如同一個中文標籤名，不希望被翻譯成不同的英文標籤造成索引錯誤。
   3. 不做任何處理：如果字段未出現在以上兩種規則中，將保留原文，不做任何處理。適用於日期、url 等。

GitHub Actions 自動化指南

你可以在自己項目倉庫下創建.github/workflows/ci.yml ，當檢測到GitHub 倉庫更新後，可以使用GitHub Actions 自動進行翻譯處理，並自動commit 回原倉庫。

ci.yml的內容可參考模板：ci_template.yml

你需要在倉庫的Settings - Secrets and variables - Repository secrets中添加兩個secrets： CHATGPT_API_BASE和CHATGPT_API_KEY ，並在程序auto-translater.py中將import env語句註釋掉。

錯誤排除

1. 如果需要驗證ChatGPT API key 的可用性，可以使用程序verify-api-key.py 進行測試。如果在國內使用官方API，需要有本地代理。
2. 如果Markdown 中的Front Matter 無法被正常識別，可以使用程序detect_front_matter.py 測試。
3. 在使用GitHub Actions 遇到問題時，請優先檢查路徑引用是否正確（例如dir_to_translate dir_translated_en dir_translated_es dir_translated_ar processed_list ）。

待解決的問題

1. 在某些特殊的情況下，可能會出現翻譯不准確、或某些字段沒有翻譯的情況，建議翻譯後手動校驗再發布文章。
2. （已解決）如果Markdown 中包含Front Matter，將保留Front Matter 的原始內容。 Front Matter 部分參數翻譯的功能正在開發中。

貢獻

歡迎你參與本項目的改進！如果您想要貢獻代碼、報告問題或提出建議，請查看貢獻指南。

版權和許可

本項目採用MIT 許可證。

問題和支持

如果你在使用Auto-i18n 時遇到任何問題，或者需要技術支持，請隨時提交問題。

我的博客使用Auto-i18n 實現了多語言支持，你可以到Power's Wiki 查看Demo 效果。

致謝

• 感謝chatanywhere/GPT_API_free 提供的免費ChatGPT API key。
• 感謝linweiyuan/go-chatgpt-api 提供的把網頁版ChatGPT 轉API 的方法。