News for hackers. Stuff that matters.

Ask HN: Best way to make diagram for GitHub project?

I want to make great documentation for my open source Github project related to data engineering.

My project involves parsing and rearranging blocks of data extensively. This makes it confusing to describe in writing, but trivial to understand visually (for that kind of thinker).

The diagram is basically lots of multicolored rectangles being grouped and rearranged.

What do people here recommend?

( 2 comments | 4 points | on HN )
Re:Ask HN: Best way to make diagram for GitHub project? by dreamcompiler on Sunday August 19, 2018 @01:41PM (#17795295)
Generate SVG files with Inkscape, then link them to your GH MD files like so: https://github.com/potherca-blog/StackOverflow/blob/master/q...
Re:Ask HN: Best way to make diagram for GitHub project? by rapnie on Sunday August 19, 2018 @02:20PM (#17795497)
I really like PlantUML, because you can just define diagrams as plain text.

I use the VS Code plugin for PlantUML + Markdown - easy generation of PNG for use on GH.

Needless to say: works best with UML diagrams, but also supports general diagrams (untested by me).

http://plantuml.com