teamwanari / sbt-paradox-diagrams

paradox directives for diagrams

GitHub

sbt-paradox-diagrams

Build Status Latest version Documentation Scala Steward badge Mergify Status

A simple paradox plugin, which will draw diagrams from formal definitions.

Supported Diagram Types

Setup

Add the following lines to your project/plugins.sbt:

addSbtPlugin("com.wanari" % "sbt-paradox-diagrams" % "<current-version>")

Example

@@@ sequence-diagram
```raw
Andrew->China: Says Hello
Note right of China: China thinks about it
China-->Andrew: How are you?
Andrew->>China: I am good thanks!
```
@@@ 

see the docs for more examples.