Веб-редактор

DocPlatform включает редактор форматированного текста на базе Tiptap (основан на ProseMirror), который отображает Markdown в реальном времени, сохраняя полную совместимость с исходным Markdown. Каждое ваше изменение формирует чистый файл .md — без проприетарных форматов и привязки к платформе.

Макет редактора

┌─────────────────────────────────────────────────────────────┐
│  Sidebar          │  Editor                                 │
│                   │                                         │
│  📁 Getting       │  ┌──────────────────────────────────┐   │
│     Started       │  │ Frontmatter (collapsible)        │   │
│  📁 Guides        │  │ Title: ___________________       │   │
│  📁 API           │  │ Description: ______________      │   │
│    > auth.md      │  │ Tags: [api] [auth]               │   │
│    > endpoints    │  └──────────────────────────────────┘   │
│  📄 changelog     │                                         │
│                   │  Start writing here...                  │
│  ┌────────────┐   │                                         │
│  │ + New Page │   │                                         │
│  └────────────┘   │  ┌──────────────────────────────────┐   │
│                   │  │ Toolbar: B I Link Image Code ... │   │
└───────────────────┴──┴──────────────────────────────────┘   │

Боковая панель

  • Дерево страниц — вложенный список всех страниц workspace. Перетаскивайте для изменения порядка.
  • New Page — создание новой страницы на корневом уровне или вложенной в существующую.
  • Быстрый поиск — нажмите или используйте Cmd+K / Ctrl+K для открытия полнотекстового поиска.

Форма frontmatter

Сворачиваемая секция frontmatter в верхней части редактора предоставляет поля формы для метаданных страницы:

Поле Описание Обязательно
Title Заголовок страницы и метка навигации Да
Description Краткое описание для результатов поиска и SEO-метатегов Нет
Tags Метки категоризации для фильтрации и обнаружения Нет
Published Переключатель для включения/исключения из публичного сайта Нет
Access Уровень видимости: public, workspace, restricted Нет

Изменения полей frontmatter автоматически обновляют блок YAML в файле .md.

Панель инструментов

Панель форматирования обеспечивает быстрый доступ к:

Действие Сочетание клавиш Описание
Полужирный Cmd+B Полужирный текст
Курсив Cmd+I Курсивный текст
Код Cmd+E Встроенный код
Ссылка Cmd+K Вставка или редактирование гиперссылки
Заголовок 1-3 Cmd+Shift+1/2/3 Заголовки разделов
Маркированный список Cmd+Shift+8 Ненумерованный список
Нумерованный список Cmd+Shift+7 Нумерованный список
Список задач Cmd+Shift+9 Список с чекбоксами
Цитата Cmd+Shift+> Блочная цитата
Блок кода Cmd+Alt+C Огражденный блок кода с выбором языка
Изображение — Загрузка или вставка изображения
Таблица — Вставка таблицы
Горизонтальная линия --- Разделительная линия

Режимы работы

Режим форматированного текста (по умолчанию)

Редактор отображает Markdown как отформатированный контент. Заголовки выглядят как заголовки, ссылки кликабельны, блоки кода имеют подсветку синтаксиса.

Режим raw Markdown

Нажмите переключатель </> на панели инструментов, чтобы перейти к редактированию raw Markdown. Это дает текстовое представление файла с подсветкой синтаксиса.

Режим raw полезен для:

  • Тонкой настройки форматирования Markdown
  • Прямого редактирования frontmatter YAML
  • Вставки контента из других источников
  • Использования пользовательских компонентов (Callout, Tabs и т.д.)

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

Автосохранение

DocPlatform автоматически сохраняет вашу работу каждые несколько секунд. Индикатор статуса отображается на панели инструментов:

Статус Значение
Saved Все изменения записаны на диск
Saving… Запись в процессе
Unsaved changes Правки ожидают сохранения (плохое соединение или ошибка)

Если включена синхронизация git, каждое сохранение инициирует автоматический commit. Коммиты группируются — быстрые правки формируют один commit с сообщением формата: docs: update {page-title}.

Работа с контентом

Изображения

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

Поддерживаемые форматы: PNG, JPG, GIF, SVG, WebP.

Таблицы

Вставляйте таблицы через панель инструментов. Таблицы поддерживают:

  • Добавление/удаление строк и столбцов
  • Переключение строки заголовка
  • Выравнивание текста (по левому краю, по центру, по правому краю)
  • Синтаксис Markdown-таблиц в режиме raw

Блоки кода

Вставляйте блоки кода через панель инструментов или введя тройные обратные кавычки (```). Выберите язык для подсветки синтаксиса — Shiki поддерживает более 200 языков.

// Code blocks with syntax highlighting
function greet(name) {
  return `Hello, ${name}!`;
}

Внутренние ссылки

Ссылайтесь на другие страницы workspace с помощью стандартных ссылок Markdown:

See the [API Authentication](/ru/docs/reference/api/) guide.

DocPlatform проверяет внутренние ссылки, а команда doctor сообщает о битых ссылках.

Сочетания клавиш

Сочетание Действие
Cmd+S Принудительное сохранение
Cmd+K Открыть диалог поиска
Cmd+Z Отмена
Cmd+Shift+Z Повтор
Cmd+/ Переключить комментарий Markdown
Tab Увеличить отступ элемента списка
Shift+Tab Уменьшить отступ элемента списка
Cmd+Enter Переключить выполнение задачи (в списках задач)
Escape Закрыть диалоги / снять выделение

Примечание: В Windows и Linux замените Cmd на Ctrl.

Совместная работа в реальном времени

Когда несколько пользователей работают в одном workspace, индикаторы присутствия показывают, кто онлайн и какую страницу просматривает. В боковой панели отображаются аватары пользователей рядом со страницами, которые в данный момент редактируются.

DocPlatform не поддерживает одновременное редактирование одной страницы несколькими пользователями. Если два пользователя попытаются сохранить конфликтующие изменения на одной странице, Content Ledger обнаружит коллизию через хеширование контента и вернет ошибку 409 с обеими версиями, доступными для ручного разрешения.

Советы

  • Перетаскивайте страницы в боковой панели для реорганизации структуры документации
  • Компоненты панели инструментов — вставляйте callouts, блоки кода и таблицы через панель инструментов редактора
  • Вставка форматированного текста из Google Docs, Notion или Confluence — редактор конвертирует его в чистый Markdown
  • Значения frontmatter по умолчанию — установите значения по умолчанию на уровне workspace для published, access и tags, чтобы избежать повторного ввода