This repository is keep (UML) diagrams in source control and be humen readable. It supports both diagrams using Mermaid.
Mermaid is a text-first charting tool that renders a Markdown-inspired text. It currently supports:
- Flow diagrams
- Sequence diagram
- class diagram
- state diagram
- and more
Check Mermaid's doc for more details.
When using Mermaid, it is recommended to use VS code with this extension
Github autumatically generates the mermaid diagram in an .md
file.
Mermaid is compatible with draw.io. See more here
Example
graph TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]