Редактор документов — руководство пользователя

Что такое модуль «Документы»

Модуль — это полнофункциональный rich-text редактор внутри YoBench для создания внутренних wiki, личных заметок и проектной документации. Под капотом — TipTap (на ProseMirror): команды через /-меню, расширенный набор блоков, диаграммы Mermaid и Draw.io, формулы KaTeX, wiki-ссылки между документами, история версий и AI-ассистент.

Что вы получаете:

Иерархия страниц — вложенные документы с боковым деревом и breadcrumbs.
Богатый редактор — заголовки, списки задач, таблицы, цитаты, code blocks с подсветкой 28 языков, callout, toggle, оглавление, find & replace, emoji.
Диаграммы и формулы — Mermaid, Draw.io (интерактивный), математика на KaTeX.
Медиа — изображения с изменением размера, встраивание видео YouTube/Vimeo, файлы-вложения.
Wiki-ссылки — [[Название страницы]] с автодополнением; обратные ссылки автоматически.
История версий — до 50 снимков на страницу с возможностью восстановления.
AI-ассистент — Summarize, Continue Writing, Translate (на 8 языков), Improve Text.
Экспорт/импорт — Markdown, HTML, ZIP-архивы; импорт .md создаёт новую страницу.
Локальное хранение — все страницы и версии в зашифрованной БД YoBench.
Пагинация избранного и корзины — длинные списки звёздочек и удалённых страниц подгружаются страницами, сайдбар остаётся отзывчивым.

Параметры страницы

При создании или редактировании:

Заголовок — отображаемое имя.
Иконка — emoji из набора.
Обложка — URL изображения (опционально).
Родитель — для вложенности.
Флаги — избранное, удалена (корзина), шаблон.

Тегов и категорий пока нет — структурирование строится через иерархию страниц и избранное.

Возможности редактора

Форматирование

Жирный, курсив, подчёркивание, зачёркивание, моноширинный код.
Цвет текста, выделение, нижний и верхний индекс.
Выравнивание (лево / центр / право).

Блоки структуры

Заголовки H1, H2, H3.
Маркированные и нумерованные списки.
Списки задач с чекбоксами.
Цитаты, code blocks (28 языков, подсветка через lowlight).
Таблицы с редактированием ячеек.
Горизонтальные разделители.
Callout-блоки: Info / Warning / Success / Error.
Toggle-блоки (сворачиваемые).
Динамическое оглавление (TOC).

Расширенные блоки

Wiki-ссылки — синтаксис [[Название]], автодополнение по существующим страницам.
Mermaid — диаграммы в коде.
Draw.io — интерактивный векторный редактор.
KaTeX — inline и block-уровень формулы.
Видео — встраивание YouTube/Vimeo.
Изображения — drag-and-drop загрузка с изменением размера.
Вложения — произвольные файлы к странице.

Slash-команды

Введите / в редакторе — откроется меню с быстрыми вставками: /heading1, /heading2, /heading3, /bulletList, /taskList, /table, /image, /codeBlock, /math, /mermaid, /drawio, /video, /quote, /toggle, /toc, /divider и другие.

Find & Replace, Emoji-пикер

Стандартный поиск и замена, плюс emoji-пикер из тулбара.

История версий

Снимок (docs_page_versions) автоматически создаётся при переходе на другую страницу.
Хранится до 50 версий на страницу — старые автоматически удаляются.
В UI История версий — список со временем; кнопка Восстановить делает выбранную версию текущей, а текущая сохраняется как новая версия.

AI-ассистент

В тулбаре редактора кнопка с иконкой автоулучшения. Доступные действия:

Summarize — краткое резюме выделенного текста или всей страницы.
Continue Writing — продолжение текста в том же стиле.
Translate — перевод на 8 языков (English, Russian, German, Spanish, French, Portuguese, Chinese, Japanese).
Improve Text — улучшение грамматики и ясности.

Результат можно вставить в позицию курсора или заменить выделение. Используется AI-провайдер из глобальных настроек модуля.

Экспорт и импорт

Markdown (.md) — экспорт текущей страницы.
HTML (.html) — экспорт с inline-стилями.
ZIP (Markdown) — все страницы как набор .md-файлов.
ZIP (HTML) — все страницы как набор .html-файлов.
Импорт .md — создаёт новую страницу из файла.
Отправка в Контекст — содержимое страницы можно отправить в Context Manager & RAG для последующего AI-поиска.

Глобальные настройки

В Настройки → Документы:

AI-провайдер для документов (docsAiProviderId) — какой провайдер из реестра AI Chat обслуживает Summarize / Continue / Translate / Improve.

Флоу использования

1. Создайте первую страницу

Откройте модуль Документы в левом меню.
В сайдбаре нажмите + Новая страница.
Введите заголовок и (опционально) иконку.
Откройте страницу.

2. Пишите контент

Печатайте текст; / открывает Slash-меню.
Перетаскивайте файлы прямо в редактор для вложений и изображений.
Используйте [[]] для wiki-ссылки на другую страницу.

3. Создавайте структуру

Перетаскивайте страницы в сайдбаре, чтобы менять иерархию.
Помечайте часто используемые страницы как Избранное.

4. Используйте AI-ассистент

Выделите текст → кнопка AI в тулбаре → выберите действие. Результат вставится или заменит выделение.

5. Откатывайтесь к версиям

Откройте панель История версий → выберите снимок → Восстановить. Текущее содержимое сохранится как ещё одна версия.

6. Экспортируйте

Меню страницы → Экспорт → выберите формат. Для всего раздела — Экспорт ZIP.

Что дальше

Подключите AI-провайдеров для работы AI-ассистента.
Сохраняйте свою документацию в Контексты и RAG, чтобы AI Chat отвечал по ней.
Для визуальных карт мыслей и whiteboard используйте Board.

Помощь и обратная связь

Хотели бы теги, совместное редактирование или другие форматы экспорта? Напишите нам через форму обратной связи.