mdbook-mermaid

A preprocessor for mdbook to add mermaid.js support.

It turns this:

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

into this:

Simple Graph

in your book. (Graph provided by Mermaid Live Editor)

Installation

If you want to use only this preprocessor, install the tool:

cargo install mdbook-mermaid

Add the following to your book.toml

```toml [preprocessor.toc] command = "mdbook-mermaid" renderer = ["html"]

[output.html] additional-css = ["mermaid.css"] additional-js = ["mermaid.min.js", "mermaid-init.js"] ```

Copy the files (mermaid.css, mermaid.min.js, mermaid-init.js) from the [assets/] (assets) directory into your source directory.

Finally, build your book:

mdbook path/to/book

License

MPL. See LICENSE.
Copyright (c) 2018 Jan-Erik Rediger janerik@fnordig.de

Mermaid is MIT licensed. The bundled assets (mermaid.css, mermaid.min.js) are MIT licensed.