Files
2023-12-07 20:47:44 +01:00

4.8 KiB

Automatický preklad dokumentácie 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 | se | sk | uk | bg | hr | lt | lv | et | cat

Táto dokumentácia bola automaticky preložená a môže obsahovať chyby. Neváhajte otvoriť Pull Request na navrhnutie zmien.

Inštalácia

Nástroj je možné nainštalovať pomocou NPM:

    npm install -g autotranslatedoc

Uistite sa, že ste nastavili premenné prostredia: GITHUB_PERSONAL_ACCESS_TOKEN a OPENAI_API_KEY. Alternatívne je možné tieto tokeny preniesť ako parametre. Pre získanie GITHUB_PERSONAL_ACCESS_TOKEN sa pozrite do dokumentácie GitHubu.

"

Použitie

Stránka s pomocou

Prístup k stránke s pomocou pomocou nasledujúceho príkazu:

 autotranslatedoc -h

Preklad dokumentácie

Autotranslatedoc prijíma 3 argumenty a mnoho možností

    autotranslatedoc <príkaz> <repo_org> <repo_názov> (možnosti)
  • príkaz môže byť buď: translate (pre preklad), update (pre aktualizáciu prekladu), build (pre zostavenie prekladu)
  • repo_org je organizácia cieľového repozitára na GitHub
  • repo_názov je názov cieľového repozitára na GitHub

Hlavné dostupné možnosti sú:

  • --language <jazyk_1>(, <jazyk_2>)* (alebo -l) pre výber jazyka, do ktorého chcete preložiť.
  • --docPath </url/cesta> (alebo -d) pre obmedzenie prekladu na súbory v konkrétnej ceste.
  • --savePath <./lokalnaCesta> (alebo -s) pre výber adresára, kde bude uložený súbor so zachovaným prekladom (predvolené je ./save).
  • --outputPath <./lokalnaCesta> (alebo -o) pri použití build, pre určenie, kde budú umiestnené preložené súbory dokumentácie (predvolené je ./build)

Pre preklad dokumentácie cieľového repozitára do francúzštiny a španielčiny použite:

    autotranslatedoc translate run-llama llama_index -l fr,es

Tento príkaz vytvorí súbor llama_index.json v priečinku run-lama v zadanom výstupnom adresári (predvolené je ./save).

    ls ./save
        run-llama
            llama_index.json 

Súbor so zachovaným prekladom obsahuje všetky preklady a môže byť použitý na generovanie dokumentácie vo vybranom formáte (momentálne iba .md).

Pre zostavenie preloženej dokumentácie použite:

    autotranslatedoc build run-llama llama_index -l fr,es

Tento príkaz vytvorí priečinky fr a es v buildPath (predvolené je ./build), ktoré obsahujú preložené súbory dokumentácie.

Pre aktualizáciu preloženej dokumentácie na základe zmien v pôvodných súboroch použite:

    autotranslatedoc update run-llama llama_index -l fr,es

Pre prehliadanie dokumentácie cez server (experimentálna funkcia) použite:

    autotranslatedoc serve run-llama llama_index

Preklad dokumentácie Docusaurus

Pre preklad dokumentácie hostovanej v Docusaurus použite:

    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

Preklad iba súboru README.md

Ak chcete preložiť iba súbor README, použite režim readme:

    autotranslatedoc translate run-llama LlamaIndexTS -l fr,es -m readme
    autotranslatedoc build run-llama LlamaIndexTS  -l fr,es -m readme

Preklad do všetkých podporovaných jazykov

Ak chcete preložiť do všetkých podporovaných jazykov, použite možnosť -l all:

    autotranslatedoc translate run-llama LlamaIndexTS -l all -m readme
    autotranslatedoc build run-llama LlamaIndexTS  -l all -m readme

Známe problémy

Momentálne je preklad s použitím -all podporovaný iba z angličtiny do všetkých ostatných jazykov.