Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 4.75 KB

README_pt.md

File metadata and controls

107 lines (72 loc) · 4.75 KB

Tradução Automática de Documentação OpenAI

en| zh-Hans | es | ru | de | fr | ja | ko | 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 | et | cat

Esta documentação foi traduzida automaticamente e pode conter erros. Não hesite em abrir um Pull Request para sugerir alterações.

Instalação

A ferramenta pode ser instalada via NPM:

    npm install -g autotranslatedoc

Certifique-se de configurar as variáveis de ambiente: GITHUB_PERSONAL_ACCESS_TOKEN e OPENAI_API_KEY. Alternativamente, esses tokens podem ser passados como parâmetros. Consulte a documentação do GitHub para obter um GITHUB_PERSONAL_ACCESS_TOKEN.

Uso

Página de Ajuda

Acesse a página de ajuda com o seguinte comando:

 autotranslatedoc -h

Traduzindo Documentação

O Autotranslatedoc recebe 3 argumentos e várias opções

    autotranslatedoc <comando> <repo_org> <repo_name> (opções)
  • comando pode ser: translate (para traduzir), update (para atualizar uma tradução), build (para construir uma tradução)
  • repo_org é a organização do repositório de destino no GitHub
  • repo_name é o nome do repositório de destino no GitHub

As principais opções disponíveis são:

  • --language <lang_1>(, <lang_2>)* (ou -l) para selecionar o idioma para o qual você deseja traduzir.
  • --docPath </url/path> (ou -d) para limitar a tradução a arquivos em um caminho específico.
  • --savePath <./localPath> (ou -s) para selecionar o diretório onde o arquivo de salvamento será salvo (padrão é ./save).
  • --outputPath <./localPath> (ou -o) ao usar build, para especificar onde os arquivos de documentação traduzidos serão salvos (padrão é ./build)

Para traduzir a documentação de um repositório de destino para francês e espanhol, use:

    autotranslatedoc translate run-llama llama_index -l fr,es

Este comando cria um arquivo llama_index.json no diretório run-lama do diretório de saída especificado (o padrão é ./save).

    ls ./save
        run-llama
            llama_index.json 

O arquivo de salvamento contém todas as traduções e pode ser usado para gerar a documentação em um formato de destino (atualmente apenas .md).

Para construir a documentação traduzida, use:

    autotranslatedoc build run-llama llama_index -l fr,es

Este comando gera os diretórios fr e es no buildPath (padrão é ./build) contendo os arquivos de documentação traduzidos.

Para atualizar a documentação traduzida com base em alterações nos arquivos originais, use:

    autotranslatedoc update run-llama llama_index -l fr,es

Para revisar a documentação por meio de um servidor (recurso experimental), use:

    autotranslatedoc serve run-llama llama_index

Traduzindo Documentação do Docusaurus

Para traduzir a documentação hospedada no Docusaurus, use:

    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

Traduzindo apenas o README.md

Para traduzir apenas o arquivo README, use o modo readme:

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

Traduzindo para Todos os Idiomas Suportados

Para traduzir para todos os idiomas suportados, use a opção -l all:

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

Problemas Conhecidos

Atualmente, a tradução com -all é suportada apenas do inglês para todos os outros idiomas.