Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 4.98 KB

README_de.md

File metadata and controls

108 lines (73 loc) · 4.98 KB
Raw

OpenAI Automatische Dokumentationsübersetzung

en| zh-Hans | es | ru | 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 | et | cat

Diese Dokumentation wurde automatisch übersetzt und kann Fehler enthalten. Zögern Sie nicht, einen Pull Request zu öffnen, um Änderungen vorzuschlagen.

Installation

Das Tool kann über NPM installiert werden:

    npm install -g autotranslatedoc

Stellen Sie sicher, dass die Umgebungsvariablen GITHUB_PERSONAL_ACCESS_TOKEN und OPENAI_API_KEY eingerichtet sind. Alternativ können diese Tokens als Parameter übergeben werden. Lesen Sie die GitHub-Dokumentation für die Erstellung eines GITHUB_PERSONAL_ACCESS_TOKEN.

"

Verwendung

Hilfeseite

Greifen Sie auf die Hilfeseite mit dem folgenden Befehl zu:

 autotranslatedoc -h

Übersetzung der Dokumentation

Autotranslatedoc hat 3 Argumente und viele Optionen

    autotranslatedoc <Befehl> <repo_org> <repo_name> (Optionen)
  • Befehl kann entweder translate (um zu übersetzen), update (um eine Übersetzung zu aktualisieren), build (um eine Übersetzung zu erstellen) sein.
  • repo_org ist die Organisation des Ziel-Repositories auf GitHub.
  • repo_name ist der Name des Ziel-Repositories auf GitHub.

Die wichtigsten verfügbaren Optionen sind:

  • --language <lang_1>(, <lang_2>)* (oder -l) um die gewünschte Zielsprache auszuwählen.
  • --docPath </url/path> (oder -d) um die Übersetzung auf Dateien in einem bestimmten Pfad zu beschränken.
  • --savePath <./localPath> (oder -s) um das Verzeichnis auszuwählen, in dem die Speicherdatei gespeichert wird (Standard ist ./save).
  • --outputPath <./localPath> (oder -o) bei Verwendung von build, um anzugeben, wo die übersetzten Dokumentationsdateien ausgegeben werden sollen (Standard ist ./build).

Um die Dokumentation eines Ziel-Repositories ins Französische und Spanische zu übersetzen, verwenden Sie:

    autotranslatedoc translate run-llama llama_index -l fr,es

Dieser Befehl erstellt eine llama_index.json-Datei im run-lama-Verzeichnis des angegebenen Ausgabeverzeichnisses (Standard ist ./save).

    ls ./save
        run-llama
            llama_index.json

Die Speicherdatei enthält alle Übersetzungen und kann verwendet werden, um die Dokumentation in einem Zielformat zu generieren (derzeit nur .md).

Um die übersetzte Dokumentation zu erstellen, verwenden Sie:

    autotranslatedoc build run-llama llama_index -l fr,es

Dieser Befehl generiert fr und es Verzeichnisse im buildPath (Standard ist ./build), die die übersetzten Dokumentationsdateien enthalten.

Um die übersetzte Dokumentation basierend auf Änderungen in den Originaldateien zu aktualisieren, verwenden Sie:

    autotranslatedoc update run-llama llama_index -l fr,es

Um die Dokumentation über einen Server zu überprüfen (experimentelles Feature), verwenden Sie:

    autotranslatedoc serve run-llama llama_index

Übersetzung von Docusaurus-Dokumentation

Für die Übersetzung von in Docusaurus gehosteter Dokumentation verwenden Sie:

    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

Nur README.md übersetzen

Um nur die README-Datei zu übersetzen, verwenden Sie den readme-Modus:

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

Übersetzung in alle unterstützten Sprachen

Um in alle unterstützten Sprachen zu übersetzen, verwenden Sie die Option -l all:

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

Bekannte Probleme

Derzeit wird die Übersetzung mit -all nur von Englisch in alle anderen Sprachen unterstützt.