java
Mermaid
java | Mermaid | |
---|---|---|
34 | 90 | |
967 | 3,584 | |
2.2% | 3.2% | |
8.8 | 9.1 | |
7 days ago | 6 days ago | |
Java | TypeScript | |
Apache License 2.0 | MIT License |
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.
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?
Mermaid
- Conquering System Design Diagrams: My Shift to Mermaid.js
- Mermaid Live Editor
- Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M
-
Using Mermaid JS to generate a diagram from Power Automate
Mermaid JS is a tool that lets you create diagrams and charts such as flowcharts, sequence diagrams, Gantt charts using simple text commands. It works by converting your text commands into a graphical representation that you can customize and share. https://mermaid.live/
- FLaNK Stack Weekly 22 January 2024
-
LLMs and Programming in the first days of 2024
I'm not OP, but I just ask GPT to turn code or process or whatever else into a mermaid diagram. Most of the time I don't even need to few-shot prompt it with examples. Then you dump the resulting text into something like https://mermaid.live/ and voilà.
-
Open-source drawing tool – Excalidraw
I like excalidraw for live discussions but if I want to make more detailed or better looking diagrams, I really enjoy these two tools:
- For drag-and-drop/WYSIWYG, I really like DrawIO. They have a web version https://app.diagrams.net/ but I strongly recommend the desktop version https://github.com/jgraph/drawio-desktop/releases/
- For text-as-diagram, I think Mermaid wins this by default since GitHub added markdown support for these: https://mermaid.live/ (This was github's announcement https://github.blog/2022-02-14-include-diagrams-markdown-fil... )
-
I lost a full day's work thanks to Mermaid.
After hours without being able to solve this problem, I decided to make the chart directly in Mermaid's live editor and export it to PNG and SVG. The big problem is that the letters are still too small, the quality of the PNG is very low, and the SVG only works on the web, not with other applications like PowerPoint and Inkscape.
-
Nomnoml
You can export to PNG and other formats in the Mermaid editor https://mermaid.live/
-
Creating mindmaps with ChatGPT
Copy paste code here: https://mermaid.live
What are some alternatives?
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
plantuml - Generate diagrams from textual description
dsl - Structurizr DSL
kroki - Creates diagrams from textual descriptions!
c4-draw.io - Draw.io template/diagram containing C4 Model shapes. Drawio Diagrams.net
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
emacs-drawio
golang-nextjs-portable - Go program with embedded Next.js app.
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
DrawThe.Net - drawthe.net draws network diagrams dynamically from a text file describing the placement, layout and icons. Given a yaml file describing the hierarchy of the network and it's connections, a resulting diagram will be created.
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
wavedrom - :ocean: Digital timing diagram rendering engine