#mdbook #mermaid #graph #add #js #book

bin+lib mdbook-mermaid

mdbook preprocessor to add mermaid support

32 releases

0.14.0 Sep 11, 2024
0.13.0 Dec 13, 2023
0.12.6 Dec 19, 2022
0.12.2 Nov 29, 2022
0.2.2 Jul 16, 2019

#221 in Text processing

Download history 2041/week @ 2024-08-22 1619/week @ 2024-08-29 2230/week @ 2024-09-05 2649/week @ 2024-09-12 2772/week @ 2024-09-19 2528/week @ 2024-09-26 2258/week @ 2024-10-03 2564/week @ 2024-10-10 2294/week @ 2024-10-17 2478/week @ 2024-10-24 2538/week @ 2024-10-31 2459/week @ 2024-11-07 2472/week @ 2024-11-14 2155/week @ 2024-11-21 2006/week @ 2024-11-28 1706/week @ 2024-12-05

8,790 downloads per month
Used in mdbook-dtmo

MPL-2.0 license

2.5MB
2.5K SLoC

JavaScript 2K SLoC // 0.0% comments Rust 483 SLoC

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

From source

To install it from source:

cargo install mdbook-mermaid

This will build mdbook-mermaid from source.

Using cargo-binstall

If you have cargo-binstall already:

cargo binstall mdbook-mermaid

This will download and install the pre-built binary for your system.

Manually

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:

Configure your mdBook to use mdbook-mermaid

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

License

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

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

Dependencies

~14–25MB
~382K SLoC