mermaid
c4-notation
mermaid | c4-notation | |
---|---|---|
127 | 127 | |
68,184 | 25 | |
1.7% | - | |
9.9 | 10.0 | |
6 days ago | almost 5 years ago | |
JavaScript | ||
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
-
Code Diagrams - 3 Tools to Try
Mermaid is a JavaScript-based diagramming and charting tool that makes it easy to create diagrams from text descriptions. It's particularly useful for generating flowcharts, sequence diagrams, and class diagrams.
-
Show HN: Unforget, the note-taking app I always wanted: offline first, encrypted
I'm always on a quest for a better structured knowledge storage, and while I usually stay away from electron apps / desktop JS, I see that the most experimentation comes from them.
Since it's a JS application, have you considered supporting Mermaid diagrams? While heavy, Joplin is my goto for notes these days because Mermaid syntax has been a game changer compared to simple markdown.
https://mermaid.js.org/
-
Integrate Ory in a NestJS application
To visualize the user flow for the CatFoster project, we will create a series of diagrams using Mermaid to illustrate the different user interactions within the system. These interactions include signing up and signing in, creating a cat profile, updating and deleting their cat profiles, requesting to foster a cat, and approving fostering requests.
-
Show HN: Collaborative, text-based technical diagramming tool
There is no documentation of the syntax. How is this different from MermaidJS[1]?
[1]https://mermaid.js.org/#/
-
AsciidocFX: The Asciidoc Editor for documentation and authoring
Mermaid Diagram - Create diagrams using text and code
-
Creating Animated Diagrams for LinkedIn
Mermaid - https://mermaid.js.org/
-
ChatCraft Adventures #13, UI Changes
This is an Issue I opened up for a potential feature. A couple weeks ago, I added nomnoml support to ChatCraft. ChatCraft renders previews for Mermaid and Nomnoml.
-
Building a Mermaid.js Gantt Chart in a FileMaker Web Viewer
Mermaid JS is a powerful JavaScript library that allows developers to create complex diagrams and visualizations using simple text and code syntax. It’s a lot like markdown, but for charts instead of plain text.
-
ChatCraft Adventures #10
Currently, ChatCraft supports Mermaid rendering. This feature request involves adding support for nomnoml rendering. Nomnoml is similar to Mermaid, in that they're both used in generating uml diagrams.
- Ask HN: Anyone use a code to mindmap/flowchart tool?
c4-notation
-
Book: Just Enough Software Architecture
Simon Brown is another person who has done a far better job than me of "democratizing" software architecture for developers. His talks [1] and workshops on architecture are exceptionally effective and his C4 architecture modeling language [2] is getting real traction.
I have youtube videos too [3] but they aren't as effective.
[1] https://www.youtube.com/results?search_query=simon+brown+arc...
[2] https://c4model.com/
[3] https://www.youtube.com/playlist?list=PLRqKmfi2Jh3uoMnZdaWmC...
-
Ask HN: Guidelines for making clear architecture diagrams
Second this.
Reference for anyone looking I to it: https://c4model.com/
There is also quite a lot of options for helping create these diagrams. I've found https://structurizr.com/ to be the best of what I've tried so far.
-
Show HN: Flyde – an open-source visual programming language
What you are describing sounds a lot like C4: https://c4model.com/
-
Ask HN: How do you document complex software systems?
The C4 model [0] provides a mostly sensible structure and techniques for representing pure software systems across different abstraction levels.
For systems involving software and hardware, or other complex interfacing (both technology and bureaucracy) this starts to delve into the universe of systems engineering. There's a decent assembly of knowledge on that in the SEBoK [1].
As another commenter has already called out too, one of the most valuable sources of information is also _why_ a system is in its current form and _how_ that's changed over time. ADR's [2] really do a good job at nailing this for just about any scale.
[0]: https://c4model.com
[1]: https://sebokwiki.org
[2]: https://adr.github.io
-
A View on Functional Software Architecture
There a various standards for documenting software architecture, like arc42 or C4. While useful and somewhat well-known (there is certainly a correlation here), here architecture documentation can be further simplified, particularly due to the self-similarity of project and component. Following is a small template, that can also serve as a project's and component's README:
- The C4 model for visualising software architecture
-
Inkscape Cloud Architect
I would suggest that if your architecture diagrams are a bunch of icons provided by AWS/Azure/GCP with lines pointing at each other... you are doing it wrong.
The 'what does this box do for my system' is vastly more important than the 'which in vogue offering from my cloud provider implements it'.
I highly suggest folks take a look at the C4 Model: https://c4model.com/
- What do you wish business folks knew about UML?
-
How to create interactive zoomable software architecture diagrams
We often use abstractions in software engineering to communicate complex architectures and software systems. In this article, we’ll discuss how abstractions are inherently hierarchical and how the C4 model provides a nested structure for defining your software architecture. We’ll then cover how IcePanel allows you to create interactive and zoomable diagrams for your audience to zoom in and out of different levels of technical detail.
What are some alternatives?
plantuml - Generate diagrams from textual description
excalidraw - Virtual whiteboard for sketching hand-drawn like 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
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
backstage - Backstage is an open framework for building developer portals
draw.io - draw.io is a JavaScript, client-side editor for general diagramming.
pumla - pumla - systematic re-use of model elements described with PlantUML
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.