4.7 KiB
OpenAI Automatisk Dokumentationsoversættelse
en| zh-Hans | es | ru | de | fr | ja | ko | pt | it | ar | tr | pl | nl | vi | th | fa | ro | sv | hu | cs | el | fi | he | no | hi | zh_tw | in | sl | se | sk | uk | bg | hr | lt | lv | et | cat
Denne dokumentation er blevet automatisk oversat og kan indeholde fejl. Tøv ikke med at åbne en Pull Request for at foreslå ændringer.
Installation
Værktøjet kan installeres via NPM:
npm install -g autotranslatedoc
Sørg for at opsætte miljøvariablerne: GITHUB_PERSONAL_ACCESS_TOKEN og OPENAI_API_KEY. Alternativt kan disse tokens sendes som parametre. Se GitHub-dokumentationen for at få en GITHUB_PERSONAL_ACCESS_TOKEN.
Brug
Hjælpeside
Få adgang til hjælpesiden med følgende kommando:
autotranslatedoc -h
Oversættelse af dokumentation
Autotranslatedoc tager 3 argumenter og mange muligheder
autotranslatedoc <kommando> <repo_org> <repo_navn> (muligheder)
kommandokan enten være:translate(til oversættelse),update(til opdatering af en oversættelse),build(til opbygning af en oversættelse)repo_orger organisationen for det målrettede repository på GitHubrepo_navner navnet på det målrettede repository på GitHub
De vigtigste tilgængelige muligheder er:
--language <sprog_1>(, <sprog_2>)*(eller-l) for at vælge det sprog, du vil oversætte til.--docPath </url/sti>(eller-d) for at begrænse oversættelsen til filer i en bestemt sti.--savePath <./lokalSti>(eller-s) for at vælge mappen, hvor gemte filen skal gemmes (standard er./save).--outputPath <./lokalSti>(eller-o) ved brug afbuild, for at angive, hvor de oversatte dokumentationsfiler skal placeres (standard er./build)
For at oversætte dokumentationen for et målrettet repository til fransk og spansk, skal du bruge:
autotranslatedoc translate run-llama llama_index -l fr,es
Denne kommando opretter en llama_index.json fil i run-lama mappen i den angivne output mappe (standard er ./save).
ls ./save
run-llama
llama_index.json
Gemte fil indeholder alle oversættelser og kan bruges til at generere dokumentationen i et målrettet format (i øjeblikket kun .md).
For at opbygge den oversatte dokumentation skal du bruge:
autotranslatedoc build run-llama llama_index -l fr,es
Denne kommando genererer fr og es mapper i buildPath (standard er ./build), der indeholder de oversatte dokumentationsfiler.
For at opdatere den oversatte dokumentation baseret på ændringer i de originale filer, skal du bruge:
autotranslatedoc update run-llama llama_index -l fr,es
For at gennemgå dokumentationen via en server (eksperimentel funktion), skal du bruge:
autotranslatedoc serve run-llama llama_index
Oversættelse af Docusaurus Dokumentation
For at oversætte dokumentation, der er hostet i Docusaurus, skal du bruge:
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
Kun oversættelse af README.md
For kun at oversætte README-filen, skal du bruge readme-tilstand:
autotranslatedoc translate run-llama LlamaIndexTS -l fr,es -m readme
autotranslatedoc build run-llama LlamaIndexTS -l fr,es -m readme
Oversættelse til alle understøttede sprog
For at oversætte til alle understøttede sprog, skal du bruge -l all muligheden:
autotranslatedoc translate run-llama LlamaIndexTS -l all -m readme
autotranslatedoc build run-llama LlamaIndexTS -l all -m readme
Kendte problemer
I øjeblikket understøttes oversættelse med -all kun fra engelsk til alle andre sprog.