Document Editor — User Guide

What the Docs module does

The module is a full-featured rich-text editor inside YoBench for internal wikis, personal notes and project documentation. Under the hood — TipTap on ProseMirror: /-command menu, an extensive block set, Mermaid and Draw.io diagrams, KaTeX formulas, wiki-links between pages, version history, and an AI assistant.

What you get:

Page hierarchy — nested documents with a sidebar tree and breadcrumbs.
Rich editor — headings, task lists, tables, quotes, code blocks with syntax highlighting (28 languages), callouts, toggles, table of contents, find & replace, emoji picker.
Diagrams and formulas — Mermaid, Draw.io (interactive), KaTeX math.
Media — resizable images, YouTube/Vimeo embeds, file attachments.
Wiki-links — [[Page name]] with autocomplete; backlinks tracked automatically.
Version history — up to 50 snapshots per page with restore.
AI assistant — Summarize, Continue Writing, Translate (8 languages), Improve Text.
Export/import — Markdown, HTML, ZIP archives; .md import creates a new page.
Local storage — all pages and versions in YoBench's encrypted database.
Paginated favorites and trash — long lists of starred or deleted pages load in pages so the sidebar stays responsive.

Page parameters

When creating or editing:

Title — display name.
Icon — emoji from the picker.
Cover image — URL (optional).
Parent — for nesting.
Flags — favorite, deleted (trash), template.

Tags and categories are not implemented yet — structure happens via hierarchy and favorites.

Editor features

Formatting

Bold, italic, underline, strikethrough, inline code.
Text color, highlight, subscript and superscript.
Alignment (left / center / right).

Structural blocks

Headings H1, H2, H3.
Bulleted and numbered lists.
Task lists with checkboxes.
Quotes, code blocks (28 languages, lowlight).
Tables with cell editing.
Horizontal dividers.
Callout blocks: Info / Warning / Success / Error.
Toggle blocks (collapsible).
Dynamic table of contents (TOC).

Advanced blocks

Wiki-links — [[Page name]] with autocomplete on existing pages.
Mermaid — diagrams in code.
Draw.io — interactive vector editor.
KaTeX — inline and block math.
Video — YouTube/Vimeo embeds.
Images — drag-and-drop upload with resize handles.
Attachments — arbitrary files attached to a page.

Slash commands

Type / in the editor to open a menu of quick inserts: /heading1, /heading2, /heading3, /bulletList, /taskList, /table, /image, /codeBlock, /math, /mermaid, /drawio, /video, /quote, /toggle, /toc, /divider and more.

Find & Replace, emoji picker

Standard search-and-replace plus an emoji picker from the toolbar.

Version history

A snapshot (docs_page_versions) is created automatically when you switch to another page.
Up to 50 versions per page are kept; older are pruned.
The Version history panel lists snapshots with timestamps; Restore makes the picked version current and the previous current is saved as a new version.

AI assistant

The editor toolbar has an "auto-improve" button. Available actions:

Summarize — short summary of selected text or the whole page.
Continue Writing — continue the text in the same style.
Translate — translate to 8 languages (English, Russian, German, Spanish, French, Portuguese, Chinese, Japanese).
Improve Text — improve grammar and clarity.

Results can be inserted at the cursor or replace the selection. The AI provider is taken from the module's global setting.

Export and import

Markdown (.md) — export the current page.
HTML (.html) — export with inline styles.
ZIP (Markdown) — all pages as a set of .md files.
ZIP (HTML) — all pages as a set of .html files.
Import .md — creates a new page from a file.
Send to Context — page content can be pushed into Context Manager & RAG for later AI lookup.

Global settings

Under Settings → Docs:

AI provider for Docs (docsAiProviderId) — which provider from the AI Chat registry powers Summarize / Continue / Translate / Improve.

Workflow

1. Create your first page

Open the Docs module from the left sidebar.
In the sidebar click + New page.
Enter a title and optionally pick an icon.
Open the page.

2. Write content

Type text; / opens the slash menu.
Drag files right into the editor for attachments and images.
Use [[]] for a wiki-link to another page.

3. Build structure

Drag pages in the sidebar to change hierarchy.
Mark frequently used pages as Favorite.

4. Use the AI assistant

Select text → AI button in the toolbar → pick an action. The result inserts or replaces the selection.

5. Roll back to a version

Open the Version history panel → pick a snapshot → Restore. The current content is preserved as another version.

6. Export

Page menu → Export → pick a format. For the whole tree — Export ZIP.

Next steps

Connect AI providers so the AI assistant works.
Push your docs into Contexts & RAG so AI Chat can answer from them.
For mind maps and whiteboarding, use Board.

Help and feedback

Want tags, collaborative editing or more export formats? Contact us via the feedback form.