https://github.com/blampe/goat
Embed diagrams in source code comments; build script greps through and writes out an SVG. A caveat is that to be adequately productive, you need rectangle-oriented editing, such as with Emacs’ “M-x string-rectangle”.
Tables are a pain, but most technical docs do not require rowspan and other things that are impossible to maintain in Markdown/reST/Asciidoc.
Diagrams are just a shitshow. PlantUML is the biggest player, and it tries to do the right thing by separating semantics and presentation, but kinda fails when your diagram grows too large.
I wish there was some tool that you could feed three separate human-readable inputs:
- styles, which let you define what your elements look like - semantics, which let you describe your elements and relationships - layout, which lets you manually rearrange the elements on your diagram (and is generated by a WYSIWYG tool)
Pikchr generates nice diagrams, but it's an all-in-one dialect. At least when I am reading well-written PlantUML I can understand the meaning of the diagram without seeing the rendered image.
The tool in the OP is nice, but it doesn't let you describe the layout at all.
Disclosure: I'm the dev
discussion of format: https://stackoverflow.com/questions/59416025/format-of-draw-...
Looks like they have an api too: https://jgraph.github.io/mxgraph/docs/js-api/files/index-txt...
I only throw in D3 because it does have some features which make SVGs more maintainable and easy to write, but I've written many SVGs by hand over the years and it really isn't nearly as bad as many people think it is. I suspect a lot of people think it is very difficult because they only look at the terrible SVGs generated by GUI tools.
restofthefuckingowl.jpg
I've been meaning to forever but both svgs and d3 are complex enough I'm not sure where to start.
For starting with SVGs, just look for a simple tutorial like https://www.w3schools.com/graphics/svg_intro.asp to get a simple template, but focus on learning the path element. The path element is both foundational to a lot of custom SVG stuff and isn't too complicated, sort of like the Basic of graphics.
I've gotten the hang of SVGs, is MBostock's blog still the best place to start with D3?
Often I use invisible subgraphs to accomplish this sort of thing in GraphViz, but the markup for doing so is complicated and non-obvious.
But PlantUML's documentation is too scattered that it's hard to know how much it supports.
Overall, to me, PlantUML is one of the more promising trade-off for userability and sophistication.
I wonder if we could pool our resource together to help one reach to more userability.
"A picture paints a thousand words", so why should we expect it possible to describe some pictures with less words.
Some paintings can be described effectively with "four tins of campbells tomato soup, one in each quadrant".
Other pictures cannot - "Adam reaching out to touch Gods finger"
Maybe we just need to paint sometimes, and maybe learn the difference between the two kinds - when we need to escape from code.
You can write the markdown and then drag and drop boxes (or directly edit the SVG).
Have the simple ones front and centre, but also go full pedal to the medal and show flesh out the really complex ones.
Recent and related shout-out: Neo4J has thankfully included some on their API documentation.
1. Engineering diagrams, explaining concepts to other engineers who are using the diagram as a jumping off point to deeper explorations
2. "Business" diagrams - the sort of thing we want to see in a Medium article or presentation. The style and correct placement matters far more than engineering.
The first is very amenable to markdown style production - often we want to spend no more than a few minutes creating the diagram. We get (60?) 80% of the way there with 20% effort.
But with every markdown approach I have tried the remaining 20% is flat out days of work. There is almost always a need to place that box there and have this one below and to the right and dammit the layout engine will not agree.
What I would ideally like is a combo - markdown to get me most of the way there, and then drop into some vector format that lets me tweak.