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

Then let mdbook-mermaid add the required files and configuration:

mdbook-mermaid install path/to/your/book

This will add the following configuration to your book.toml:

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

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

It will skip any unnecessary changes and detect if mdbook-mermaid was already configured.

Additionally it copies the files mermaid.css, mermaid.min.js and mermaid-init.js into your book's directory. You find these files in the src/bin/assets directory.

Finally, build your book:

mdbook path/to/book

License

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

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