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:
in your book. (Graph provided by Mermaid Live Editor)
To install it from source:
cargo install mdbook-mermaid
This will build mdbook-mermaid from source.
If you have cargo-binstall already:
cargo binstall mdbook-mermaid
This will download and install the pre-built binary for your system.
Binary releases are available on the Releases page.
Download the relevant package for your system, unpack it, and move the mdbook-mermaid executable into $HOME/.cargo/bin:
When adding mdbook-mermaid for the first time, let it add the required files and configuration:
mdbook-mermaid install path/to/your/book
This will add the following configuration to your book.toml:
[preprocessor.mermaid]
command = "mdbook-mermaid"
[output.html]
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.min.js and mermaid-init.js into your book's directory.
You find these files in the src/bin/assets directory.
You can modify mermaid-init.js to configure Mermaid, see the Mermaid documentation for all options.
Finally, build your book:
mdbook path/to/book
MPL. See LICENSE.
Copyright (c) 2018-2024 Jan-Erik Rediger [email protected]
Mermaid is MIT licensed.
The bundled assets (mermaid.min.js) are MIT licensed.
