Сообщество - Типичный программист

Типичный программист

1 438 постов 6 710 подписчиков

Популярные теги в сообществе:

18

Диаграммы - Mermaid

Хорошо нарисованная диаграмма может объяснить концепцию гораздо лучше текста, к тому же диаграмму гораздо легче понять, ведь вам не нужно ничего визуализировать у себя в голове пока вы читаете текст.
Особенно часто приходится рисовать диаграммы при написании документации к коду, например, когда необходимо нарисовать архитектуру проекта или его части.
Для создания диаграмм очень удобно использовать Mermaid. Синтаксис выглядит следующим образом:

graph TD;
A-->B;
A-->C;
B-->D;
C-->D;

К тому же Mermaid поддерживается:
- GitHub
- GitLab
- Notion

Таким образом, вы можете хранить ваши диаграммы прямо в Markdown разметке. Просто нарисуйте вашу диаграмму в Mermaid Live Editor и скопируйте код в вашу документацию. Больше не нужно хранить диаграммы в виде картинок и искать исходники каждый раз, когда необходимо внести правки! Все ваши диаграммы — просто код.


https://t.me/cherkashindev/60

Диаграммы  - Mermaid
Показать полностью 1
Отличная работа, все прочитано!