Carl Burks is a software developer for a global financial institution. With over ten years experience in technology and software development for financial organizations and over twenty years of software experience, Carl Burks provides articles, musings and insight into technology issues, software development, and other selected topics.

Mermaids, Markdown, and UML

2018-09-27T23:04:11.000-07:00

Authors:
Carl Burks

A friend at work turned me on to a product called mermaid. It has an option to integrate with pandoc.

See https://github.com/mermaidjs/mermaid.cli

pandoc.exe -t html -F mermaid-filter.cmd -o test.html .\test.md

It can render uml diagrams from a markup language.

Here is an example of what it the code looks like:

https://www.burksbrand.com/static/images/test.md

Here is what it renders out to: https://www.burksbrand.com/static/images/diagram-1.svg

As a fan of documentation this makes modeling your code fairly painless, it also makes the source of the diagrams diff-able since they are text files.