d2-docs
C4-PlantUML
d2-docs | C4-PlantUML | |
---|---|---|
2 | 24 | |
253 | 6,072 | |
2.0% | 1.7% | |
8.2 | 6.9 | |
10 days ago | 2 days ago | |
D2 | PlantUML | |
BSD 3-clause "New" or "Revised" License | 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.
d2-docs
- Animated diagrams with D2, a text-to-diagram language written in Go
-
D2 language, open source alternative to PlantUML
You're right, d2-docs will be changed to render all diagrams with Dagre or ELK instead.
The docs existed before D2 was open source and we had open source layout options. Sorry about that.
https://github.com/terrastruct/d2-docs/issues/43
> By the way I've just realised why your github repo does not provide the sources of the diagrams in docs - it would blow your game wide open, once users start asking why they aren't getting the results depicted. And almost no compileable examples, either
Not sure what you mean no compilable examples. Full source of the docs is at https://github.com/terrastruct/d2-docs including all the examples. The first example in the Github repo also had a line "Rendered with the TALA layout engine" so the source was upfront.
> Will you please stop lying? I am not "mad" because something isn't free, but because you're misrepresenting the nature of your D2 language. It is not something that you're making available to benefit community, but a thinly disguised marketing ploy.
We're running a company, we're absolutely interested in making money.
But open sourcing D2 doesn't just help us with user acquisition, it certainly also helps the community in adding another open source alternative in the text to diagram market. And it's good quality code. If we go under, someone else can pickup the torch and fork D2.
And it's incorrect to say that the free engines are not as good. They absolutely are suitable alternatives and do beat TALA in many instances. It's not in our interest to hide the best parts of D2, or else no one would use it. I'd even go as far to say TALA will never be as good as them in many instances, especially when the structure is hierarchical. But that's ok, they all use different algorithms and that's what makes them good in different instances. TALA is specifically for software diagrams, in instances such as if you have many nested containers.
If you can quote a specific piece of text on our GitHub or website, we will change it to make it more clear that D2 is fully open source and TALA is just an optional optimization.
C4-PlantUML
-
Ask HN: Guidelines for making clear architecture diagrams
Third this. Don't look any further, just do it!
Also, PlantUML + C4 is like peanut butter & jelly:
https://github.com/plantuml-stdlib/C4-PlantUML
I'll gladly give up control of layout, and accept some ugliness, to never again have to worry about dragging boxes and arrows to be pixel-aligned, and then do it all over again when I add another box...
It looks like Mermaid has C4 support too:
https://mermaid.js.org/syntax/c4.html
-
Documentation as Code for Cloud - C4 Model & Structurizr
C4-PlantUML: Export your model as C4-PlantUML diagrams.
-
Which tools do you use to create diagrams?
PlantUML + C4 plugin;
-
Add quick sketches in emacs org mode
Yes. I use this all the time for software diagramming. With c4 model (https://github.com/plantuml-stdlib/C4-PlantUML) and AWS icons (https://github.com/awslabs/aws-icons-for-plantuml)
-
Architecture diagrams should be code
The C4 model (https://c4model.com/) is great for architecture diagrams. You can use different tools to generate them. Here are the ones I've been using:
- https://github.com/plantuml-stdlib/C4-PlantUML
- D2 language, open source alternative to PlantUML
- Keep your diagrams updated with continuous delivery
- What FOSS programs would you recommend for creating concept maps on Linux?
-
C4 model for system architecture design
3️⃣ Text-based diagramming- C4-PlantUML
-
Ask HN: Confluence Alternative(s) Supporting Markdown?
> onboarding docs
yes, they're don't changing frequently
> system design docs
yes - see C4-PlantUML[1]
> meeting notes
no, unless they're directly code related like ADRs [2,3].
Although one can abuse Github Issues + comments for this, in my opinion it's better to use modern SaaS tools for this, i.e. Loom, Descript, Linear.app, etc. - you can automate this process, e.g. transcribe the meeting's recording and add the issue/repo using Github Actions.
--
[1] https://github.com/plantuml-stdlib/C4-PlantUML
[2] https://adr.github.io/
[3] https://docs.aws.amazon.com/prescriptive-guidance/latest/arc...
What are some alternatives?
TALA - A diagram layout engine designed specifically for software architecture diagrams
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
d2-playground - An online runner to play, learn, and create with D2, the modern diagram scripting language that turns text to diagrams.
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
d2-mode - emacs major mode for d2 graphs
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
mdbook-d2 - D2 diagram generator plugin for MdBook
Azure-PlantUML - PlantUML sprites, macros, and other includes for Azure services
backstage - Backstage is an open platform for building developer portals
text-to-diagram-site - Compare syntax, layouts, outputs between languages for generating diagrams with text.
dsl - Structurizr DSL