Блоки, Markdown и видео
Редактор документации хранит содержимое блоками. Используйте Markdown для переноса текста, а блоки — для настройки инструкции на странице.
Выберите подходящий блок
Доступны текст, заголовок, изображение, таблица, список, список задач, ссылка, код, предупреждение, уведомление, раскрываемый блок, цитата и видео. Для обычного действия пишите короткий шаг; для команды или примера используйте код. В тексте можно добавлять гиперссылки.
Для изображения добавьте понятную подпись: какой экран открыт и что должен увидеть пользователь. Не включайте пароли, токены или реальные ключи. Отдельного блока произвольного HTML сейчас нет.
Импортируйте Markdown
- Откройте нужную страницу в режиме правки.
- Установите место вставки и выберите импорт Markdown.
- Добавьте Markdown выбранным в диалоге способом и подтвердите импорт.
- Проверьте добавленные блоки и сохраните.
Импорт добавляет блоки в текущую позицию, а не заменяет страницу. Сырые HTML-фрагменты преобразуются в код; проверьте результат перед публикацией. Импорта целого дерева страниц из ZIP нет.
Экспортируйте текст
Можно экспортировать текущую страницу или всю документацию в ZIP. Страницы дерева размещаются в упорядоченных папках вида 01-slug/index.md. Экспорт может включать текущие несохранённые изменения открытой страницы, поэтому для точного снимка опубликованного текста сначала сохраните её.
Изображения не скачиваются внутрь экспортируемого ZIP: ссылки на них нужно проверить отдельно при переносе.
Добавьте видео
Видеоблок поддерживает RUTUBE и VK Видео. Укажите подходящую ссылку, проверьте воспроизведение и добавьте подпись. Для обложки доступны URL, «Получить постер» и «Загрузить постер». Если автоматическое получение не удалось, загрузите обложку вручную. Для VK проверьте корректную ссылку встраивания, включая требуемый hash. Загрузка видеофайлов и YouTube в этом блоке не поддерживаются.
Меню блоков, импорт и экспорт Markdown и настройки видеоблока.
Далее: дерево документации и сохранение.