Шаблон:Mermaid

Материал из свободной русской энциклопедии «Традиция»
Перейти к навигации Перейти к поиску

{{Mermaid}} — шаблон, позволяющий внедрять в страницы визуализации, отрисованные программой Mermaid.

Визуализация описывается особым языком, похожим на Markdown.

Программа визуализации написана на языке JavaScript и выполняется на стороне сервера с помощью node.js и puppeteer. Таким образом, отображение визуализации не зависит от наличия JavaScript в браузере и даже от наличия самого браузера.

Параметры[править код]

  1. или mermaid — описание визуализации. Все | должны быть заменены на {{!}}, }} на } }, = на {{=}} (вместо последнего можно использовать именованный параметр mermaid),
  • ширина (необязательный) — ширина в пикселях,
  • высота (необязательный) — высота в пикселях,
  • тема (необязательный) — тема. Возможные значения: default (умолчание), neutral, forest, dark,
  • фон (необязательный) — цвет. Возможные значения: #RRGGBB или название цвета CSS. Умолчание: white.

Примеры[править код]

Викитекст Вывод
{{mermaid|sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
 }}

JohnBobAliceJohnBobAliceloop[Healthcheck]Rational thoughts prevail!Hello John, how are you?Fight against hypochondriaGreat!How about you?Jolly good!

{{mermaid|theme=dark|background=transparent|classDiagram
 Class01 <{{!}}-- AveryLongClass : Cool
 Class03 *-- Class04
 Class05 o-- Class06
 Class07 .. Class08
 Class09 --> C2 : Where am i?
 Class09 --* C3
 Class09 --{{!}}> Class07
 Class07 : equals()
 Class07 : Object[] elementData
 Class01 : size()
 Class01 : int chimp
 Class01 : int gorilla
 Class08 <--> C2: Cool label}}

Cool

Where am i?

Cool label

Class01

int chimp

int gorilla

size()

AveryLongClass

Class03

Class04

Class05

Class06

Class07

Object[] elementData

equals()

Class08

Class09

C2

C3

{{mermaid|theme=neutral|%%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': {
              'tagLabelColor': '#ff0000',
              'tagLabelBackground': '#00ff00',
              'tagLabelBorder': '#0000ff'
       } } }%%
       gitGraph
       commit
       branch develop
       commit tag:"v1.0.0"
       commit
       checkout main
       commit type: HIGHLIGHT
       commit
       merge develop
       commit
       branch featureA
       commit
}}

maindevelopfeatureA0-9dc61741-961ad0av1.0.02-b8591b23-a4e15f04-ae944cd6-982d0ae7-9931697

Требуемые настройки External Data[править код]

Для работы этого шаблоны требуется активировать преднастройку External Data mermaid и развернуть одноимённый контейнер в соответствии с инструкциями, приложенными к расширению.

Системные требования[править код]

Ссылки[править код]