Herunterladen

Dokument-Editor — Benutzerhandbuch | YoBench

So verwenden Sie das Modul „Docs" in YoBench: TipTap-Richtext-Editor, Wiki-Links, Mermaid und Draw.io, KaTeX, Versionshistorie, KI-Assistent.

Was das Modul „Docs" leistet

Das Modul ist ein vollwertiger Rich-Text-Editor in YoBench für interne Wikis, persönliche Notizen und Projektdokumentation. Unter der Haube TipTap auf ProseMirror: /-Befehlsmenü, umfangreicher Block-Satz, Mermaid- und Draw.io-Diagramme, KaTeX-Formeln, Wiki-Links zwischen Seiten, Versionsverlauf und ein KI-Assistent.

Was Sie bekommen:

  • Seiten-Hierarchie — verschachtelte Dokumente mit Sidebar-Baum und Breadcrumbs.
  • Reicher Editor — Überschriften, Aufgabenlisten, Tabellen, Zitate, Code-Blöcke mit Syntax-Highlighting (28 Sprachen), Callouts, Toggles, Inhaltsverzeichnis, Find & Replace, Emoji-Picker.
  • Diagramme und Formeln — Mermaid, Draw.io (interaktiv), KaTeX-Mathe.
  • Medien — größenveränderbare Bilder, YouTube/Vimeo-Einbettungen, Datei-Anhänge.
  • Wiki-Links[[Seitenname]] mit Autocomplete; Backlinks werden automatisch verfolgt.
  • Versionsverlauf — bis zu 50 Snapshots pro Seite mit Wiederherstellung.
  • KI-Assistent — Summarize, Continue Writing, Translate (8 Sprachen), Improve Text.
  • Export/Import — Markdown, HTML, ZIP-Archive; .md-Import erstellt eine neue Seite.
  • Lokale Speicherung — alle Seiten und Versionen in der verschlüsselten DB von YoBench.
  • Paginierte Favoriten und Papierkorb — lange Listen markierter oder gelöschter Seiten werden seitenweise geladen, die Seitenleiste bleibt reaktiv.

Seitenparameter

Beim Erstellen oder Bearbeiten:

  • Titel — Anzeigename.
  • Icon — Emoji aus dem Picker.
  • Coverbild — URL (optional).
  • Eltern — für Verschachtelung.
  • Flags — Favorit, gelöscht (Papierkorb), Vorlage.

Tags und Kategorien sind noch nicht implementiert — Strukturierung erfolgt über Hierarchie und Favoriten.

Editor-Funktionen

Formatierung

  • Fett, kursiv, unterstrichen, durchgestrichen, Inline-Code.
  • Textfarbe, Markierung, Tief- und Hochstellung.
  • Ausrichtung (links / Mitte / rechts).

Strukturblöcke

  • Überschriften H1, H2, H3.
  • Aufzählungs- und nummerierte Listen.
  • Aufgabenlisten mit Checkboxen.
  • Zitate, Code-Blöcke (28 Sprachen, lowlight).
  • Tabellen mit Zellbearbeitung.
  • Horizontale Trennlinien.
  • Callout-Blöcke: Info / Warnung / Erfolg / Fehler.
  • Toggle-Blöcke (klappbar).
  • Dynamisches Inhaltsverzeichnis (TOC).

Erweiterte Blöcke

  • Wiki-Links[[Seitenname]] mit Autocomplete für existierende Seiten.
  • Mermaid — Code-basierte Diagramme.
  • Draw.io — interaktiver Vektor-Editor.
  • KaTeX — Inline- und Block-Mathematik.
  • Video — YouTube/Vimeo einbetten.
  • Bilder — Drag-and-Drop-Upload mit Größenänderung.
  • Anhänge — beliebige Dateien zur Seite.

Slash-Befehle

Schreiben Sie / im Editor — ein Menü mit Schnell-Einfügungen öffnet sich: /heading1, /heading2, /heading3, /bulletList, /taskList, /table, /image, /codeBlock, /math, /mermaid, /drawio, /video, /quote, /toggle, /toc, /divider und mehr.

Find & Replace, Emoji-Picker

Standardsuche und -ersetzung plus Emoji-Picker aus der Symbolleiste.

Versionsverlauf

  • Ein Snapshot (docs_page_versions) wird automatisch beim Wechsel zu einer anderen Seite erstellt.
  • Bis zu 50 Versionen pro Seite werden gespeichert; ältere werden entfernt.
  • Im UI Versionsverlauf stehen Snapshots mit Zeitstempel; Wiederherstellen macht die gewählte Version aktuell, der bisherige Stand wird als neue Version gespeichert.

KI-Assistent

In der Editor-Symbolleiste steht eine Auto-Improve-Schaltfläche. Verfügbare Aktionen:

  • Summarize — Kurzfassung des markierten Textes oder der Seite.
  • Continue Writing — Text im gleichen Stil fortsetzen.
  • Translate — Übersetzung in 8 Sprachen (Englisch, Russisch, Deutsch, Spanisch, Französisch, Portugiesisch, Chinesisch, Japanisch).
  • Improve Text — Grammatik und Klarheit verbessern.

Ergebnisse lassen sich einfügen an der Cursorposition oder die Auswahl ersetzen. Der KI-Anbieter stammt aus den globalen Modul-Einstellungen.

Export und Import

  • Markdown (.md) — Export der aktuellen Seite.
  • HTML (.html) — Export mit Inline-Styles.
  • ZIP (Markdown) — alle Seiten als .md-Dateien.
  • ZIP (HTML) — alle Seiten als .html-Dateien.
  • .md-Import — erstellt eine neue Seite aus einer Datei.
  • An Kontext senden — Seiteninhalt in den Context Manager & RAG schieben für späteres KI-Lookup.

Globale Einstellungen

Unter Einstellungen → Docs:

  • KI-Anbieter für Docs (docsAiProviderId) — welcher Anbieter aus der AI Chat-Registrierung Summarize / Continue / Translate / Improve antreibt.

Ablauf

1. Erste Seite anlegen

  1. Öffnen Sie das Modul Docs im linken Menü.
  2. In der Seitenleiste + Neue Seite klicken.
  3. Titel eingeben und optional ein Icon wählen.
  4. Die Seite öffnen.

2. Inhalt schreiben

  • Text tippen; / öffnet das Slash-Menü.
  • Dateien direkt in den Editor ziehen für Anhänge und Bilder.
  • [[]] für Wiki-Links zu anderen Seiten verwenden.

3. Struktur aufbauen

  • Seiten in der Sidebar ziehen, um die Hierarchie zu ändern.
  • Häufig genutzte Seiten als Favorit markieren.

4. KI-Assistent nutzen

Text markieren → KI-Schaltfläche in der Symbolleiste → Aktion auswählen. Das Ergebnis wird eingefügt oder ersetzt die Auswahl.

5. Auf eine Version zurückrollen

Panel Versionsverlauf öffnen → Snapshot wählen → Wiederherstellen. Der aktuelle Inhalt wird als neue Version gespeichert.

6. Exportieren

Seitenmenü → Exportieren → Format wählen. Für den ganzen Baum — ZIP exportieren.

Nächste Schritte

  • Verbinden Sie KI-Anbieter, damit der KI-Assistent funktioniert.
  • Schieben Sie Ihre Doku in Kontexte & RAG, damit AI Chat daraus antworten kann.
  • Für Mind-Maps und Whiteboarding nutzen Sie Board.

Hilfe und Feedback

Wünschen Sie Tags, kollaboratives Bearbeiten oder weitere Export-Formate? Schreiben Sie uns über das Feedback-Formular.