4.8 KiB
Automatický překlad dokumentace OpenAI
en| zh-Hans | es | ru | de | fr | ja | ko | pt | it | ar | tr | pl | nl | vi | th | fa | ro | sv | hu | el | da | fi | he | no | hi | zh_tw | in | sl | se | sk | uk | bg | hr | lt | lv | et | cat
Tato dokumentace byla automaticky přeložena a může obsahovat chyby. Neváhejte otevřít Pull Request pro navrhování změn.
Instalace
Nástroj lze nainstalovat pomocí NPM:
npm install -g autotranslatedoc
Ujistěte se, že nastavíte proměnné prostředí: GITHUB_PERSONAL_ACCESS_TOKEN a OPENAI_API_KEY. Alternativně lze tyto tokeny předat jako parametry. Pro získání GITHUB_PERSONAL_ACCESS_TOKEN se odkazujte na dokumentaci GitHubu.
"
Použití
Stránka s nápovědou
Přístup ke stránce s nápovědou pomocí následujícího příkazu:
autotranslatedoc -h
Překlad dokumentace
Autotranslatedoc přijímá 3 argumenty a mnoho možností
autotranslatedoc <příkaz> <repo_org> <repo_name> (možnosti)
příkazmůže být buď:translate(pro překlad),update(pro aktualizaci překladu),build(pro sestavení překladu)repo_orgje organizace cílového repozitáře na GitHuburepo_nameje název cílového repozitáře na GitHubu
Hlavní dostupné možnosti jsou:
--language <lang_1>(, <lang_2>)*(nebo-l) pro výběr jazyka, do kterého chcete přeložit.--docPath </url/path>(nebo-d) pro omezení překladu na soubory v konkrétní cestě.--savePath <./localPath>(nebo-s) pro výběr adresáře, kam bude uložen soubor se uložením (výchozí hodnota je./save).--outputPath <./localPath>(nebo-o) při použitíbuild, pro určení, kam budou výstupní soubory přeložené dokumentace umístěny (výchozí hodnota je./build)
Pro přeložení dokumentace cílového repozitáře do francouzštiny a španělštiny použijte:
autotranslatedoc translate run-llama llama_index -l fr,es
Tento příkaz vytvoří soubor llama_index.json v adresáři run-lama v určeném výstupním adresáři (výchozí je ./save).
ls ./save
run-llama
llama_index.json
Uložený soubor obsahuje všechny překlady a může být použit k vygenerování dokumentace ve zvoleném formátu (v současné době pouze .md).
Pro sestavení přeložené dokumentace použijte:
autotranslatedoc build run-llama llama_index -l fr,es
Tento příkaz vytvoří adresáře fr a es v buildPath (výchozí je ./build), které obsahují přeložené soubory dokumentace.
Pro aktualizaci přeložené dokumentace na základě změn v původních souborech použijte:
autotranslatedoc update run-llama llama_index -l fr,es
Pro zobrazení dokumentace pomocí serveru (experimentální funkce) použijte:
autotranslatedoc serve run-llama llama_index
Překlad dokumentace Docusaurus
Pro překlad dokumentace hostované v Docusaurus použijte:
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
Překlad pouze souboru README.md
Pro překlad pouze souboru README použijte režim readme:
autotranslatedoc translate run-llama LlamaIndexTS -l fr,es -m readme
autotranslatedoc build run-llama LlamaIndexTS -l fr,es -m readme
Překlad do všech podporovaných jazyků
Pro překlad do všech podporovaných jazyků použijte volbu -l all:
autotranslatedoc translate run-llama LlamaIndexTS -l all -m readme
autotranslatedoc build run-llama LlamaIndexTS -l all -m readme
Známé problémy
V současné době je překlad s parametrem -all podporován pouze z angličtiny do všech ostatních jazyků.