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

4.5 KiB

OpenAI automaatne dokumentatsiooni tõlge

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 | bg | hr | lt | lv | cat

See dokumentatsioon on tõlgitud automaatselt ja võib sisaldada vigu. Ärge kartke avada Pull Request, et pakkuda muudatusi.

Paigaldamine

Tööriista saab paigaldada NPM-i kaudu:

    npm install -g autotranslatedoc

Veenduge, et olete seadistanud keskkonnamuutujad: GITHUB_PERSONAL_ACCESS_TOKEN ja OPENAI_API_KEY. Alternatiivselt saab neid võtmeid edastada parameetritena. Lisateabe saamiseks vaadake GitHubi dokumentatsiooni, et saada GITHUB_PERSONAL_ACCESS_TOKEN.

"

Kasutamine

Abileht

Juurdepääs abilehele järgmise käsu abil:

 autotranslatedoc -h

Dokumentatsiooni tõlkimine

Autotranslatedoc võtab 3 argumenti ja mitmeid valikuid

    autotranslatedoc <käsk> <repo_org> <repo_name> (valikud)
  • käsk võib olla kas: translate (tõlkimiseks), update (tõlke värskendamiseks), build (tõlke loomiseks)
  • repo_org on sihtrepositooriumi org GitHubis
  • repo_name on sihtrepositooriumi nimi GitHubis

Saadaval on järgmised peamised valikud:

  • --language <lang_1>(, <lang_2>)* (või -l) valitud tõlkekeele valimiseks.
  • --docPath </url/path> (või -d) tõlke piiramiseks konkreetse tee failidele.
  • --savePath <./localPath> (või -s) salvestusfaili salvestuskoha valimiseks (vaikimisi ./save).
  • --outputPath <./localPath> (või -o) kasutades build, et määrata tõlgitud dokumendifailide väljundkoha (vaikimisi ./build)

Sihtrepositooriumi dokumentatsiooni tõlkimiseks prantsuse ja hispaania keelde kasutage:

    autotranslatedoc translate run-llama llama_index -l fr,es

See käsk loob llama_index.json faili määratud väljundkataloogi run-lama kausta (vaikimisi on see ./save).

    ls ./save
        run-llama
            llama_index.json 

Salvestusfail sisaldab kõiki tõlkeid ja seda saab kasutada dokumentatsiooni genereerimiseks sihtvormingus (praegu ainult .md).

Tõlgitud dokumentatsiooni loomiseks kasutage:

    autotranslatedoc build run-llama llama_index -l fr,es

See käsk genereerib fr ja es kaustad buildPath-is (vaikimisi on see ./build), mis sisaldavad tõlgitud dokumentatsioonifaile.

Sihtdokumentatsiooni värskendamiseks originaalfailides tehtud muudatuste põhjal kasutage:

    autotranslatedoc update run-llama llama_index -l fr,es

Dokumentatsiooni ülevaatamiseks serveri kaudu (eksperimentaalne funktsioon) kasutage:

    autotranslatedoc serve run-llama llama_index

Docusaurus dokumentatsiooni tõlkimine

Docusaurusis majutatud dokumentatsiooni tõlkimiseks kasutage:

    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

Ainult README.md tõlkimine

Ainult README faili tõlkimiseks kasutage readme režiimi:

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

Kõigi toetatud keelte tõlkimine

Kõigi toetatud keelte tõlkimiseks kasutage -l all valikut:

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

Teadaolevad probleemid

Hetkel toetatakse tõlget -all ainult inglise keelest kõikidele teistele keeltele.