Диаграммы

Диаграммы используются, когда процесс, структуру или взаимосвязь проще показать схемой, чем описать словами. В качестве языка описания диаграмм в проекте используется Mermaid — вы пишете диаграмму обычным текстом, а система сама превращает её в изображение. Если вы ещё не знакомы с синтаксисом Mermaid, стоит сначала заглянуть в раздел «Язык диаграмм», а сюда вернуться уже за тем, как именно диаграмма встраивается в документ.

Формат

Диаграмма объявляется похоже на рисунок, но вместо ссылки на файл содержит сам код диаграммы в блоке ```mermaid:

[Diagram]: DiagramVariableName "Название диаграммы"
```mermaid
graph TD
  A --> B
```

Здесь DiagramVariableName — уникальная переменная, по которой на диаграмму можно сослаться из текста, а текст в кавычках — подпись, которая будет показана под диаграммой в готовом документе.

Особенности

С точки зрения итогового Word-документа диаграмма ведёт себя точно так же, как обычный рисунок: при рендеринге Mermaid-код превращается в статичное изображение и вставляется в документ. Из этого следует несколько практических вещей — диаграммы используют общую сквозную нумерацию вместе с рисунками (то есть рисунок и диаграмма могут идти подряд как «Рисунок 1» и «Рисунок 2»), а ссылки на них из текста формируются точно так же, через .index, как и для обычных изображений.