Live data from Hacker News

Documentation as Code for Cloud Using PlantUML

blog.dornea.nu

11–20 of 35 posts

Re: Documentation as Code for Cloud Using PlantUML

#11

What does PlantUML do better than mermaid?

Well not having chromium as a dependency is a start. But even glossing over that fact I found that it's much better for many diagrams. PlantUML is also a one stop shop. You can basically make anything kind of diagram in it.

Re: Documentation as Code for Cloud Using PlantUML

#15
I use PlantUML to create quick network diagrams.

It's the only solution I found which allows tailoring a diagram if it renders poorly.

For example, if access switches are to be on the left, and trunk switches on the right, PlantUML is the only solution I found which adequately allows the user to add such constraints, via:

S1 --E-- S2

Re: Documentation as Code for Cloud Using PlantUML

#16

One of the coolest things about plantuml is the generated PNG actually contains the source code for the image as metadata. If someone gives you an image, they don't also need to send you the source because you can extract it using the plantuml CLI.

That is so cool. Did not know this. Thank you!

Re: Documentation as Code for Cloud Using PlantUML

#17
I love PlantUML. I was always fond of it in my early days as a software engineer and still use it today, along with all the various ways to draw diagrams out there, whether it's through a web tool like draw.io or Miro or through markup like PlantUML and Mermaid.

Some stuff I'd like to share with the rest:

- PlantUML's default style has improved since the days of red/brown borders, pale yellow boxes, drop shadows and such but I've attempted fixing it before through a preset style [I've made before here](https://gist.github.com/jerieljan/4c82515ff5f2b2e4dd5122d354...). It's obsolete nowadays, since I'm sure someone has made a style generator somewhere, and last I checked, PlantUML allows a monochrome style out of the box.

- [Eraser](https://app.eraser.io) is promising, considering that it's trying to blend both diagram-as-code markup along with the usual visual diagram editor. I'm still seeing if it's worth picking up since Miro's hard to beat.

- On an unrelated note, [WikiJS](https://js.wiki/) is a self-hosted wiki that happens to support draw.io, PlantUML and MermaidJS diagrams out of the box. Quite handy to have for your own docs.

- I use Miro nowadays since it's significantly quicker to draw things freeform and to collaborate live with folks on a whiteboard at the cost of having your diagrams in markup, but it's easy to miss the integration that [you can actually import PlantUML](https://help.miro.com/hc/en-us/articles/7004940386578) and Mermaid diagrams in a Miro board too. You can also do edits too, but it's on its own PlantUML section, of course.

Re: Documentation as Code for Cloud Using PlantUML

#20
post #12

Community list of comparisons between Text to Diagram tools: https://text-to-diagram.com/

It’s worth noting that this page is made by the makers of D2 (they mention it at the bottom, it’s no secret).

For me, D2’s syntax is the easiest to write, but it outputs sparse diagrams that are difficult to read without a lot of zooming.

Post reply on HN