27 сентября 2022 г. (изменено: 28 сентября 2022 г.)
Канал: @cherkashindev
Диаграммы** - Mermaid**
Хорошо нарисованная диаграмма может объяснить концепцию гораздо лучше текста, к тому же диаграмму гораздо легче понять, ведь вам не нужно ничего визуализировать у себя в голове пока вы читаете текст. Особенно часто приходится рисовать диаграммы при написании документации к коду, например, когда необходимо нарисовать архитектуру проекта или его части. Для создания диаграмм очень удобно использовать Mermaid. Синтаксис выглядит следующим образом:
graph TD; A-->B; A-->C; B-->D; C-->D;
К тому же Mermaid поддерживается:
Таким образом, вы можете хранить ваши диаграммы прямо в Markdown разметке. Просто нарисуйте вашу диаграмму в Mermaid Live Editor и скопируйте код в вашу документацию. Больше не нужно хранить диаграммы в виде картинок и искать исходники каждый раз, когда необходимо внести правки! Все ваши диаграммы — просто код.