svgbobrus VS Mermaid

I recently had to draw some diagrams for documenting something. After looking at various Markdown-friendly options I landed on svgbob[1]. I believe it's a superior solution to these kinds of graph drawing tools for Markdown for one specific reason: the code is still readable. When I go to look at a Markdown file I don't always open the output. I will commonly open up a README file in Vim or just cat it to the terminal. In this case diagrams like those in this post is next to useless. I'm not going to read through some complex drawing definitions and try to visualise the results. With svgbob (or Typograms[2] or any of the other similar options) you can still read the Markdown text document and see the diagrams which is great!

Of course this comes with a tradeoff, drawing the diagrams can be a bit of a pain. But I believe this can be solved by a good Markdown editor or editor plugin. Alternatively a spec like this could be converted into an svgbob-compatible diagram.

[1]https://ivanceras.github.io/svgbob-editor/

Online playground svgbob-editor is also updated to use the latest version of svgbob. It is however a painfully slow to edit the diagrams from there, so it's better if you draw the diagram somwhere else and paste it to there.

There’s Svgbob. Plus when it comes to more complex diagrams or graphs where creating the ASCII art by hand in can be quite finicky, there’s a number of tools (including drawing tools) to make creating ASCII art much easier.

https://ivanceras.github.io/svgbob-editor/

svgbob

Since the post contains ASCII art, let me recommend you svgbob :)

The app can now render Svgbob code blocks (https://ivanceras.github.io/svgbob-editor).

Mermaid JS is a tool that lets you create diagrams and charts such as flowcharts, sequence diagrams, Gantt charts using simple text commands. It works by converting your text commands into a graphical representation that you can customize and share. https://mermaid.live/

I'm not OP, but I just ask GPT to turn code or process or whatever else into a mermaid diagram. Most of the time I don't even need to few-shot prompt it with examples. Then you dump the resulting text into something like https://mermaid.live/ and voilà.

I like excalidraw for live discussions but if I want to make more detailed or better looking diagrams, I really enjoy these two tools:

- For drag-and-drop/WYSIWYG, I really like DrawIO. They have a web version https://app.diagrams.net/ but I strongly recommend the desktop version https://github.com/jgraph/drawio-desktop/releases/

- For text-as-diagram, I think Mermaid wins this by default since GitHub added markdown support for these: https://mermaid.live/ (This was github's announcement https://github.blog/2022-02-14-include-diagrams-markdown-fil... )

After hours without being able to solve this problem, I decided to make the chart directly in Mermaid's live editor and export it to PNG and SVG. The big problem is that the letters are still too small, the quality of the PNG is very low, and the SVG only works on the web, not with other applications like PowerPoint and Inkscape.

You can export to PNG and other formats in the Mermaid editor https://mermaid.live/

Copy paste code here: https://mermaid.live