4.3 KiB
OpenAI 自動文件翻譯
en| zh-Hans | es | ru | de | fr | ja | ko | pt | it | ar | tr | pl | nl | vi | th | fa | ro | sv | hu | cs | el | da | fi | he | no | hi | in | sl | se | sk | uk | bg | hr | lt | lv | et | cat
此文件已自動翻譯,可能包含錯誤。如有更改建議,請毫不猶豫地提交 Pull Request。
安裝
可以通過 NPM 安裝此工具:
npm install -g autotranslatedoc
請確保設置環境變量:GITHUB_PERSONAL_ACCESS_TOKEN 和 OPENAI_API_KEY。或者,這些令牌可以作為參數傳遞。有關獲取 GITHUB_PERSONAL_ACCESS_TOKEN 的方法,請參閱 GitHub 文檔。
使用方法
幫助頁面
使用以下命令訪問幫助頁面:
autotranslatedoc -h
翻譯文件
Autotranslatedoc 接受 3 個參數和多個選項
autotranslatedoc <command> <repo_org> <repo_name> (options)
command可以是translate(翻譯)、update(更新翻譯)或build(構建翻譯)repo_org是目標儲存庫在 GitHub 上的組織名稱repo_name是目標儲存庫在 GitHub 上的名稱
可用的主要選項有:
--language <lang_1>(, <lang_2>)*(或-l)選擇要翻譯成的語言。--docPath </url/path>(或-d)限制翻譯到特定路徑中的文件。--savePath <./localPath>(或-s)選擇保存文件的目錄(默認為./save)。--outputPath <./localPath>(或-o)在使用build命令時,指定翻譯後的文件輸出目錄(默認為./build)。
要將目標儲存庫的文件翻譯為法語和西班牙語,請使用以下命令:
autotranslatedoc translate run-llama llama_index -l fr,es
此命令在指定的輸出目錄(默認為 ./save)的 run-llama 目錄中創建了一個 llama_index.json 文件。
ls ./save
run-llama
llama_index.json
保存文件包含所有翻譯,可用於生成目標格式(目前僅支持 .md)的文檔。
要構建翻譯後的文檔,請使用以下命令:
autotranslatedoc build run-llama llama_index -l fr,es
此命令在 buildPath(默認為 ./build)中生成了 fr 和 es 目錄,其中包含翻譯後的文檔文件。
要根據原始文件的更改更新翻譯後的文檔,請使用以下命令:
autotranslatedoc update run-llama llama_index -l fr,es
要通過服務器查看文檔(實驗性功能),請使用以下命令:
autotranslatedoc serve run-llama llama_index
翻譯 Docusaurus 文件
要翻譯 Docusaurus 中托管的文件,請使用以下命令:
autotranslatedoc translate run-llama LlamaIndexTS --docPath /apps/docs/docs -l fr,es -m docusaurus
autotranslatedoc build run-llama LlamaIndexTS --docPath /apps/docs/docs -l fr,es -m docusaurus
只翻譯 README.md
要僅翻譯 README 文件,請使用 readme 模式:
autotranslatedoc translate run-llama LlamaIndexTS -l fr,es -m readme
autotranslatedoc build run-llama LlamaIndexTS -l fr,es -m readme
翻譯為所有支援的語言
要翻譯為所有支援的語言,使用 -l all 選項:
autotranslatedoc translate run-llama LlamaIndexTS -l all -m readme
autotranslatedoc build run-llama LlamaIndexTS -l all -m readme
已知問題
目前,僅支援從英文到其他所有語言的 -all 翻譯。