C4-PlantUML
d2-playground
Our great sponsors
C4-PlantUML | d2-playground | |
---|---|---|
23 | 23 | |
5,948 | 57 | |
2.0% | - | |
7.1 | 7.1 | |
6 days ago | 2 months ago | |
PlantUML | JavaScript | |
MIT License | Mozilla Public 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.
C4-PlantUML
-
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:
- D2 language, open source alternative to PlantUML
- Keep your diagrams updated with continuous delivery
-
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
[3] https://docs.aws.amazon.com/prescriptive-guidance/latest/arc...
-
Do you take physical notes while working on your game? Or just play around and learn by doing?
I use a combination of: * Markdown (for notes and code blocks) * Mermaid markdown (for architectural diagrams in markdown documents) * PlantUML markdown (again for arch. docs in markdown, but mainly for C4 diagrams) * a Docker container to render PlantUML markdown to images * Joplin, installed on every device I regularly use * NextCloud, to store, secure, encrypt, and make available everywhere, the markdown notes managed by Joplin
- Diagram as Code
d2-playground
- D2 Playground
- How to draw beautiful software architecture diagrams
-
The Unreasonable Effectiveness of Sequence Diagrams in MermaidJS
https://play.d2lang.com/?script=qlDQtVOo5AIEAAD__w%3D%3D&ske...
I was going to ask why you don't have a web version but you already do. I'm going to play with this more today.
Have you thought about an "auto compile"/live mode where it changes as you edit the text? I think this adds a level of intuitiveness that would help new users explore.
- I wrote a tool in Go to write Sequence Diagrams in Go
-
Animated diagrams with D2, a text-to-diagram language written in Go
Wow that's a very detailed catch, thanks for reporting! Made an issue: https://github.com/terrastruct/d2-playground/issues/33
-
Org Novelist: A system for writing novel-length fiction using Emacs Org mode.
A video can be a lot of work, it is quite challenging to produce a satisfying result. Instead, I suggest you to draw (here is a nice online tool to do that. If you prefer plain text, you can use d2) a Flowchart to represent your workflow. For someone who wants to understand a use case, it will be much quicker to look at a diagram rather than read or watch a video. And it will be easier for you to produce it.
-
Extension for creating beautiful software architecture diagrams with text
We'll have our own API available for you to do this too. So you can make something on playground (https://play.d2lang.com) and then render the same way. E.g. https://github.com/alixander/test-render/blob/main/README.md
-
Is TypeScript actually worth It?
After years of Flow, Typescript, Webpack, React, JSX, etc, I went back to just vanilla HTML, CSS, JS for my most recent production project (https://play.d2lang.com, which is open source). The experience was great. I didn't find myself missing any of those tools.
if you're talking about the playground, I did the initial version in a weekend or so (https://github.com/terrastruct/d2-playground), which includes building a WASM version of D2 (written in Go), putting a text editor, some UI stuff like dropdowns/menu, hooking it up together, layouts and responsiveness whatnot.
If you're talking about D2 language itself, ~2 devs over 3/4 of a year.
-
Discord plugin for generating diagrams on the fly through text
You can give it a spin to see if it's a fit for you here: https://play.d2lang.com
What are some alternatives?
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
Azure-PlantUML - PlantUML sprites, macros, and other includes for Azure services
backstage - Backstage is an open platform for building developer portals
dsl - Structurizr DSL
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
c4-draw.io - Draw.io template/diagram containing C4 Model shapes. Drawio Diagrams.net
gcp-icons-for-plantuml - PlantUML sprites, macros, and other includes for Google Cloud Platform services and resources
plantuml-syntax - vim syntax file for plantuml
uml-reverse-mapper - Automatically generate class diagram from code. Supports Graphviz, PlantUML and Mermaid output formats.
diagrams - :art: Diagram as Code for prototyping cloud system architectures