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

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 ... │   │
└───────────────────┴──┴──────────────────────────────────┘   │

Бічна панель

  • Дерево сторінок — вкладений список усіх сторінок робочого простору. Перетягуйте для зміни порядку.
  • Нова сторінка — створення нової сторінки на кореневому рівні або вкладеної під наявну сторінку.
  • Ярлик пошуку — натисніть або використовуйте 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 як форматований контент. Заголовки виглядають як заголовки, посилання клікабельні, блоки коду мають підсвічування синтаксису.

Режим необробленого Markdown

Натисніть перемикач </> на панелі інструментів, щоб перейти до редагування необробленого Markdown. Це дає вам текстовий вигляд файлу з підсвічуванням синтаксису.

Режим необробленого тексту корисний для:

  • Тонкого налаштування форматування Markdown
  • Безпосереднього редагування frontmatter YAML
  • Вставки контенту з інших джерел
  • Використання користувацьких компонентів (Callout, Tabs тощо)

Зміни синхронізуються між режимами миттєво. Перемикайтесь без втрати роботи.

Автозбереження

DocPlatform автоматично зберігає вашу роботу кожні кілька секунд. Ви побачите індикатор стану на панелі інструментів:

Стан Значення
Saved Усі зміни збережено на диск
Saving… Запис у процесі
Unsaved changes Редагування очікують збереження (погане з’єднання або помилка)

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

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

Зображення

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

Підтримувані формати: PNG, JPG, GIF, SVG, WebP.

Таблиці

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

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

Блоки коду

Вставляйте блоки коду за допомогою панелі інструментів або набравши потрійні зворотні лапки (```). Оберіть мову для підсвічування синтаксису — Shiki підтримує 200+ мов.

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

Внутрішні посилання

Посилайтеся на інші сторінки у вашому робочому просторі за допомогою стандартних Markdown посилань:

See the [API Authentication](/uk/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.

Співпраця в реальному часі

Коли кілька користувачів редагують один робочий простір, індикатори присутності показують, хто онлайн та яку сторінку вони переглядають. Бічна панель відображає аватари користувачів поруч зі сторінками, які наразі редагуються.

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

Поради

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