6.4 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 | zh_tw | in | sl | se | sk | uk | hr | lt | lv | et | cat
Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.
Инсталация
Инструментът може да бъде инсталиран чрез NPM:
npm install -g autotranslatedoc
Уверете се, че сте настроили променливите на средата: GITHUB_PERSONAL_ACCESS_TOKEN и OPENAI_API_KEY. Алтернативно, тези токени могат да бъдат подадени като параметри. Вижте документацията на GitHub за получаване на GITHUB_PERSONAL_ACCESS_TOKEN.
"
Използване
Страница за помощ
Достъп до страницата за помощ със следната команда:
autotranslatedoc -h
Превеждане на документация
Autotranslatedoc приема 3 аргумента и много опции
autotranslatedoc <команда> <repo_org> <repo_name> (опции)
командаможе да бъде:translate(за превод),update(за актуализиране на превода),build(за създаване на превод)repo_orgе организацията на целевото хранилище в GitHubrepo_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
Тази команда създава файл llama_index.json в директорията run-lama на указаната директория за запазване (по подразбиране е ./save).
ls ./save
run-llama
llama_index.json
Запазеният файл съдържа всички преводи и може да се използва за генериране на документация в целевия формат (в момента само .md).
За създаване на преведената документация, използвайте:
autotranslatedoc build run-llama llama_index -l fr,es
Тази команда генерира директории fr и es в buildPath (по подразбиране ./build), съдържащи преведените файлове с документация.
За актуализиране на преведената документация въз основа на промените в оригиналните файлове, използвайте:
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 се поддържа само от английски на всички други езици.