4 ms·
I like using mermaid diagrams [1] in readme files and docs. They're easier to read than plain text explanations for architectural layouts/customer journeys but
by spacebanana7 3y ago
I like using mermaid diagrams [1] in readme files and docs.
They're easier to read than plain text explanations for architectural layouts/customer journeys but easier to modify than images and GIFs.
Also natively supported in many flavours of markdown like Gitlab.
[1] https://github.com/mermaid-js/mermaid https://github.com/mermaid-js/mermaid
- hbcondo714 3y agoSame here, I like Draw.io but just did a sequence diagram showing a Stripe integration with actors, activations and notes in a few lines of Mermaid markdown on a GitHub readme: https://github.com/hbcondo/revenut-web#-workflow https://github.com/hbcondo/revenut-web#-workflow But that diagram just renders as code for the same readme via GitHub Pages: https://revenut.com https://revenut.com