Блок коду mermaid
Діаграма Mermaid живе в блоці коду з огородженням. Огородження це три зворотні лапки. Після відкривного огородження напиши mermaid як назву мови:
```mermaid
flowchart LR
A --> B
```
Перший рядок усередині блока вказує, який це вид діаграми. Тут це flowchart LR. Усе після цього рядка описує діаграму.
Рядки, що починаються з %%, є коментарями. Засіб читання їх ігнорує.
Приклад 1: блок-схема з рішенням
```mermaid
flowchart TD
Start[Write the note] --> Check{Is it clear?}
Check -->|Yes| Publish[Share it]
Check -->|No| Edit[Rewrite it]
Edit --> Check
```
Як це читати:
flowchart TDозначає згори вниз. Для зліва направо використовуйLR. Словоgraphтакож працює замістьflowchart.Start[Write the note]створює рамку.Startце коротка назва. Текст у дужках це мітка.- Фігурні дужки
{ }створюють фігуру рішення, ромб. -->малює стрілку. Текст між вертикальними рисками, як-от|Yes|, підписує стрілку.
Приклад 2: діаграма послідовності
Діаграма послідовності показує, хто з ким спілкується, по черзі.
```mermaid
sequenceDiagram
participant U as User
participant S as Server
U->>S: Open the page
S-->>U: Send the page
U->>S: Log in
S-->>U: Welcome
```
participant U as Userстворює стовпець із назвою User. Коротка назва:U.->>це суцільна стрілка.-->>це пунктирна стрілка, яку часто використовують для відповідей.- Текст після двокрапки це повідомлення.
- Повідомлення малюються згори вниз, у тому порядку, в якому ти їх пишеш.
Приклад 3: кругова діаграма
```mermaid
pie title Time spent on a project
"Writing" : 40
"Reading" : 25
"Meetings" : 15
"Other" : 20
```
Кожен сектор це мітка в лапках, двокрапка й число. Число має бути більшим за нуль.
Інші типи діаграм
Mermaid може малювати набагато більше видів. Найпоширеніші:
- Діаграма Ґанта: завдання на часовій шкалі.
- Діаграма класів: класи в коді та те, як вони пов’язані.
- Діаграма станів: стани чогось і те, як воно переходить між ними.
- Діаграма «сутність-зв’язок»: таблиці бази даних і зв’язки.
- Подорож користувача: кроки, які робить людина.
- Ментальна карта: ідеї, що розгалужуються від одного центру.
- Часова шкала: події в порядку дат.
- Git-граф: гілки та коміти.
Кожен тип має власне перше слово й власні правила. У документації Mermaid для кожного є окрема сторінка.
Де малюються діаграми Mermaid
GitHub малює блоки Mermaid у файлах Markdown, обговореннях, запитах на злиття та вікі. Потрібен лише блок коду mermaid. Багато редакторів Markdown і застосунків для нотаток також підтримують Mermaid, але не всі.
Коли засіб читання не підтримує Mermaid, він зазвичай трактує блок як будь-який інший код. Ти бачиш текст, який написано, а не малюнок. Нічого не втрачається. Просто не намальовано.
Типові помилки
- Маленька одруківка ламає всю діаграму. Невідомі або з помилками написані ключові слова не дають їй намалюватися. Якщо ти бачиш помилку або звичайний текст, спершу перевір перший рядок і стрілки.
- Спеціальні символи в мітках. Дужки та подібні символи можуть збити з пантелику синтаксичний аналізатор. Візьми мітку в лапки:
A["Save (draft)"]. - Слово
endу блок-схемі. Малими літерамиendламає блок-схему. ПишиEndабоEND, або візьми слово в лапки. Воно може створювати проблеми й у діаграмах послідовності. - Неправильне огородження. Мовою після зворотних лапок має бути
mermaid. Без цього засіб читання бачить звичайний блок коду.
Відступи не потрібні. Більшість людей робить відступи в рядках усередині діаграми лише тому, що так легше читати.
Чати зі ШІ та агенти пишуть Mermaid
Чати зі ШІ та агенти для програмування часто вставляють Mermaid у плани, специфікації та нотатки з проєктування. Блок-схема це швидкий спосіб показати кроки. Діаграма послідовності показує, як частини системи спілкуються між собою.
Якщо чат дає тобі діаграму, скопіюй весь блок коду, разом з огородженнями, у свій файл Markdown. Якщо діаграма не малюється, перевір її за помилками вище. Короткі мітки й одна ідея на діаграму полегшують виправлення тексту.
Читання діаграм Mermaid
PilcrowMD малює діаграми Mermaid на Android і на Mac, без потреби в інтернеті. На Android торкнися діаграми, щоб побачити її на весь екран. На Mac Quick Look, порівняння та PDF показують блок коду замість малюнка.
Поширені запитання
Чи потрібно щось установлювати, щоб писати Mermaid? Ні. Ти пишеш звичайний текст у блоці коду. Потрібен лише засіб читання, який його малює.
Чому я бачу код замість діаграми? Або засіб читання не підтримує Mermaid, або в діаграмі є синтаксична помилка. Перевір, що блок починається з mermaid і що перший рядок називає справжній тип діаграми.
Чи можна змінити вигляд діаграми? Так. У Mermaid є параметри для кольорів, форм і компонування. Почни зі стандартних. Для більшості нотаток їх досить.
Також для Mac: PilcrowMD для Mac (бета)