Was macht devdocs-forge-agent?
Konvertieren Sie Video-Tutorial-Transkripte mithilfe von LLM-Agenten in strukturierte Dokumentation für Docusaurus und GitBook.
Überblick
Diese Fähigkeit automatisiert die Umwandlung von Video-Transkripten (z. B. aus YouTube oder lokalen Aufnahmen) in professionelle Dokumentationsseiten für Docusaurus und GitBook. Sie nutzt Large Language Models (LLMs), um den Text zu analysieren, technische Anweisungen zu erkennen und eine konsistente Markdown-Struktur zu erzeugen.
Funktionen
- Extrahiert Schlüsselpunkte und Codeblöcke aus Transkripten.
- Erzeugt kohärente Abschnitte mit Überschriften, Listen und Hinweisen.
- Formatiert Ausgaben für Docusaurus (Markdown mit Metadaten) und GitBook (Markdown mit Frontmatter).
- Bietet ein CLI-Tool für Batch-Verarbeitung.
- Konfigurierbar über YAML-Dateien.
Voraussetzungen
- Python 3.9 oder höher
- Ein LLM-API-Schlüssel (z. B. OpenAI, Anthropic, etc.)
- Optional: Whisper für lokale Transkription
Installation
pip install devdocs-forge-agent
Konfiguration
Erstellen Sie eine Datei config.yaml:
platform: docusaurus # oder gitbook
output_dir: ./docs
llm:
model: gpt-4
temperature: 0.2
max_tokens: 4096
videotranscript:
source: path/to/transcript.txt # oder URL
Verwendung
CLI
docs-forge build --config config.yaml
Als Python-Modul
from devdocs_forge_agent import ForgeAgent
agent = ForgeAgent(platform="docusaurus")
agent.convert("transcript.txt", output_path="./docs/tutorial.md")
Beispiele
Sie finden Beispiel-Transkripte und generierte Dokumentation im Ordner examples/.
Lizenz
MIT