search

jelly-beam / rebar3_ex_doc

rebar3 plugin for generating docs with ex_doc
Apache License 2.0
43 stars 13 forks source link

Add out-of-the-box support for mermaid #51

Closed paulo-ferraz-oliveira closed 1 year ago

paulo-ferraz-oliveira commented 1 year ago

Support for Mermaid

Out-of-the-box support for Mermaid is provided via rebar.config option with_mermaid, as follows:

{ex_doc, [
     {with_mermaid, true}
]}.

or

{ex_doc, [
     {with_mermaid, "10.2.4"}
]}.

Check out what this looks like in doc/index.html.

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

Closes #50.

starbelly commented 1 year ago

Will cut a new release tomorrow.