Перейти к содержимому
Документация

Диаграммы и формулы

Mermaid, PlantUML, Graphviz, D2, Vega, формулы и другое — рисуются из блоков кода прямо на вашем Mac.

Диаграммы прямо на странице

Опишите диаграмму текстом в блоке кода с ограждением — и Kirbon её нарисует: в визуальном режиме, в предпросмотре, рядом с Markdown, на страницах только для чтения, при печати и экспорте в PDF. В файле остаётся ровно тот текст, который вы написали, поэтому GitHub, GitLab и любой другой редактор видят тот же блок.

Страница, где вместо кода нарисованы блок-схема Mermaid и диаграмма последовательности PlantUML.Страница, где вместо кода нарисованы блок-схема Mermaid и диаграмма последовательности PlantUML.
Ограждения остаются в файле, Kirbon рисует то, что в них описано.
НотацияОграждение
Mermaid — блок-схемы, последовательности, классы, состояния, ER, диаграммы Ганта, интеллект-карты и другоеmermaid
PlantUML с библиотекой C4plantuml, puml
Graphvizdot, graphviz
D2d2
Графики Vega-Lite и Vegavega-lite, vega
Временные диаграммы WaveDromwavedrom
nomnomlnomnoml
Pikchrpikchr
Svgbob (рисунки ASCII)svgbob, bob
Формулы в LaTeXmath

Слово после ограждения можно писать в любом регистре и с продолжением (```Mermaid title="flow"). Блоки внутри списков, цитат и выносок остаются блоками кода.

Как добавить диаграмму

  • Наберите /mermaid, /plantuml или /формула и нажмите Return либо выберите Вставка ▸ Диаграмма Mermaid, Диаграмма PlantUML или Формула. Появится небольшой пример с открытым исходником.
  • Наберите ограждение, например ```d2, на пустой строке и нажмите Return.
  • Или выберите нотацию во всплывающем списке языка у блока кода: блок станет диаграммой, когда курсор уйдёт из него.

Как править диаграмму

Клик выделяет диаграмму. Нажмите Return, дважды кликните или нажмите Изменить исходник в её заголовке — исходник откроется блоком кода, а под ним будет рисунок, который обновляется по мере набора. Esc или клик в другом месте закрывает исходник.

Когда диаграмма выделена
⌫Удаляет блок (один шаг отмены)
⌘CКопирует Markdown блока вместе с ограждениями
ПробелПоказывает диаграмму в Quick Look

В контекстном меню диаграммы — Изменить исходник, Скопировать исходник, Скопировать изображение (PDF и PNG, чтобы вставить в другие программы) и Открыть диаграмму: она откроется в полном размере в Quick Look. В предпросмотре и на страницах только для чтения меню то же, без «Изменить исходник».

Если блок нарисовать не получается — например, из-за опечатки, — на странице виден исходник и над ним сообщение движка. Пока вы правите, последний удачный рисунок остаётся под исходником, приглушённый, пока исходник снова не станет рисоваться.

Светлое и тёмное оформление, масштаб, печать

Диаграммы следуют оформлению: когда Mac переходит в тёмный режим, они перерисовываются в тёмных цветах. Это векторные рисунки, поэтому они остаются чёткими при любом масштабе, при печати и в PDF. Диаграмма шире текста уменьшается до его ширины; Открыть диаграмму показывает её в полном размере.

Рисуется на вашем Mac

Движки для рисования поставляются вместе с Kirbon и работают на вашем Mac. Ничего из вашей документации никуда не отправляется: Kirbon рисует диаграммы в веб-представлении, которое никогда не показывается, и блокирует любые его попытки что-то загрузить из интернета. macOS позволяет приложению пользоваться таким веб-представлением только с разрешением на исходящие сетевые подключения, поэтому у Kirbon это разрешение есть — подробнее в разделе Конфиденциальность.

По этой же причине PlantUML не может скачивать стандартные библиотеки: C4 входит в комплект, а другие, например AWS или Azure, вместо рисунка покажут ошибку.

Нарисованная диаграмма сохраняется на этом Mac, поэтому при повторном открытии страницы она появляется сразу. Очень большие диаграммы и те, что рисуются дольше десяти секунд, показываются исходником с сообщением.

Как выключить рисование

Выключите Настройки ▸ Редактор ▸ Рисовать диаграммы и формулы — и блоки диаграмм везде будут обычными блоками кода. Файлы при этом не меняются.