mermaid-cli
java
Our great sponsors
mermaid-cli | java | |
---|---|---|
7 | 34 | |
2,048 | 967 | |
5.4% | 3.1% | |
8.4 | 8.8 | |
1 day ago | 30 days ago | |
JavaScript | Java | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
mermaid-cli
- Nomnoml
- The Unreasonable Effectiveness of Sequence Diagrams in MermaidJS
-
D2 is now open source β a new, modern language that turns text to diagrams
you can use mermaid-cli to create pngs/svgs
-
Mermaid: Create diagrams and visualizations using text and code
I come from past experiments with (py)graphviz, yed, probably a couple other forgotten things. (As well as manual diagrams in LucidChart and even Inkscape.) And am generally a non-web python guy.
I was looking at Mermaid last weekend, since a coworker has praised it a few times and I was wanting to play with it.
I think my expectation of how to use it was wrong? I typically expect to share my diagrams as .png files. The main documentation didn't seem to give much guidance in this usecase.
I ended up going to https://github.com/mermaid-js/mermaid-cli ... there didn't seem to be a simple install-and-use pathway similar to `apt` or `pip`, so I ended up trying the docker image for it. I got it working to create pngs, but I thought having to mess with docker volume mounts and defining my own aliases (`alias mermaid='docker run -u $UID -it --rm -v ~/mermaid:/data minlag/mermaid-cli -i'` so I can do `mermaid blah.mmd` in my ~/mermaid folder) was a bit cumbersome...
Just sharing to see if there's hot takes on where I went wrong, I guess. (for example, I certainly didn't extensively read the docs to understand the usage paradigm it's intended for)
- Open Source Flowchart Generator?
-
Diagrams as Code
node cli tool if java isnβt your thing. https://github.com/mermaid-js/mermaid-cli
java
-
Documentation as Code for Cloud - C4 Model & Structurizr
Structurizr is used for describing and visualizing architecture using the C4 model. One of the main selling points is the fact you can define an entire (IT) architecture model using text. A typical model consists of:
-
Architecture diagrams enable better conversations
I've been using https://structurizr.com/ to automatically generate C4 diagrams from a model (rather than drawing them by hand). It works well with the approach for written documentation as proposed in https://arc42.org/. It's very easy to embed a C4 diagram into a markdown document.
The result is a set of documents and diagrams under version control that can be rendered using the structurizr documentation server (for interactive diagrams and indexed search).
I also use https://d2lang.com/ for declarative diagrams in addition to C4, e.g., sequence diagrams and https://adr.github.io/ for architectural decision records. These are also well integrated into structurizr.
- Dynamically generate Cloud System Architecture diagram
-
Mastering Software Architecture Visualization with the C4 Model
Structurizr, available at https://structurizr.com/ and also has a free plan available with a single workspace available, is a tool that allows you to build out a C4 model using its Structurizr DSL to outline the Containers, Components, and Contexts of the architecture. It is a valuable tool for designing and visualizing a software architecture. In this example we'll build out a simple Machine Learning Pipeline, I mean a very basic one, featuring an ETL Pipeline and a model that trains images that classifies it as a image of planet earth or not. To begin, lets define our work space.
-
Top 9 software architecture tools
Structurizr builds upon "diagrams as code", allowing you to create multiple diagrams from a single model using a number of tools and programming languages.
- Architecture diagrams should be code
-
Launch HN: IcePanel (YC W23) β Onboard engineers with explorable system designs
As a customer since 2021, is this re-launch HN?
Loved the concept, found it fell over for real-sized things on even the most powerful machines, had to switch to Structurizr to do our C4 modeling: https://structurizr.com/
Was very disappointed, bet I'd get more devs to model architecture with this tool. If it's relaunching because perf problems were resolved, will look forward to try it again.
Depending on scope of people's needs, either highly recommended or, try it first.
Hats off to Victor for great support back then, and I see the docs are a reflection of that, like this section on embedding into popular tools:
https://docs.icepanel.io/features/sharing#embedding-share-li...
TL;DR: Helpful team, thoughtful UI, thoughtful docs, a product capability (c4 modeling) very worth understanding and using.
-
Keep your diagrams updated with continuous delivery
He built a tool called Structurizr for this.
-
D2 is now open source β a new, modern language that turns text to diagrams
Ah this is like https://structurizr.com which is based on C4.
- What tools do you use to map out microservices?
What are some alternatives?
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
pom-visualizer-maven-plugin - Maven plugin to visualize the POM you are working on
dsl - Structurizr DSL
windows11 - Windows 11 in React π»πβ‘ [Moved to: https://github.com/blueedgetechno/win11React]
c4-draw.io - Draw.io template/diagram containing C4 Model shapes. Drawio Diagrams.net
Fomantic-UI - Fomantic-UI is the official community fork of Semantic-UI
emacs-drawio
diagrams - :art: Diagram as Code for prototyping cloud system architectures
text-to-diagram-site - Compare syntax, layouts, outputs between languages for generating diagrams with text.
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams