Crates.io | mdbook-mermaid |
lib.rs | mdbook-mermaid |
version | 0.13.0 |
source | src |
created_at | 2019-07-10 19:37:30.567047 |
updated_at | 2023-12-13 10:34:32.693764 |
description | mdbook preprocessor to add mermaid support |
homepage | https://github.com/badboy/mdbook-mermaid |
repository | https://github.com/badboy/mdbook-mermaid |
max_upload_size | |
id | 148130 |
size | 3,015,249 |
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)
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
:
[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-2021 Jan-Erik Rediger janerik@fnordig.de
Mermaid is MIT licensed.
The bundled assets (mermaid.min.js
) are MIT licensed.