Mermaid это инструмент для создания диаграмм и графиков. С его помощью можно создавать диаграммы, используя текстовое описание.
С 2022 года GitHub поддерживает Mermaid диаграммы в Markdown файлах – это отличный способ документировать архитектуру. Например, этот текст:
```mermaid
graph LR;
Service--Webhook-->APIGateway[API Gateway];
subgraph "AWS"
APIGateway-->Lambda[Lambda];
Lambda-->DynamoDB[(DynamoDB)];
end
```
Отрисуется так:
Вот список диаграмм и графиков, которые можно создать с помощью Mermaid:
Также есть утилита командной строки
для конвертации .mmd
файлов в .svg
или .png
:
mmdc -i input.mmd -o output.svg
Посмотрите расширение для VSCode, которое добавляет поддержку Mermaid во встроенный просмотр Markdown.