Skip to content

Diagrams

Kroki

Unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Diagrams.net (experimental), Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, SvgBob, Symbolator, UMLet, Vega, Vega-Lite, WaveDrom and WireViz …and more to come!

Ascii diagrams

likec4

D2

Mermaid

Install

sudo pacman -Q mermaid-cli

Usage

Show which version of mermaid is installed:

```mermaid
info
````

Issues

Use pandoc to create PDF from markdown + mermaid

sudo apt install pandoc
npm i -g mermaid-filter

pandoc  -F mermaid-filter -o freifunk.pdf freifunk.md

NeoVim plugin

Issues:

  • Could not configure it to only render on InsertLeavei or BufWinEnter. The example config shows render_buffer = { "InsertLeave", "BufWinEnter", "TextChanged" }, but even when I take out "TextChanged" it renders on every key stroke.
  • Even simple diagrams with subgraphs lead to a very high CPU load (load ~30), because dozens of chromium processes spawn
  • Unexplained error

UML tools

  • Umbrello: Avaiable as ubuntu deb package
  • PlantUML: text to diagram, Stalled development (2018), available as .deb

DrawIO

Server rack / switch documentation

Blockdiag

  • Development stalled
  • Blockdiag can be rendered from Krok
  • nwdiag
    • generate network-diagram image file from spec-text file
    • included tools: i.e. rackdiag
    • Aur package: nwdiag