Explore Topics

Style guide

TLU can now support mermaid diagrams! Flowcharts, sequence diagrams and more!

How to write mermaid diagrams.

  1. RTFM.
  2. Wrap your mermaid code in @startmermaid and @endmermaid tags. So your code will look like

@startmermaid graph LR ... @endmermaid

  1. Note: You can’t have blank lines in your diagrams, unfortunately, because the markdown renderer will interpret this as a new paragraph and break your diagram. However, you can sort of workaround this by putting a # as a spacer (see first example).

Sequence diagram example

Flowchart example

Gantt Chart example