blob: 04e94c0e38916c6679bb5031565b625cfda5a9c3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
# mdbook-mermaid
A preprocessor for [mdbook][] to add [mermaid.js][] support.
[mdbook]: https://github.com/rust-lang-nursery/mdBook
[mermaid.js]: https://mermaidjs.github.io/
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](https://mermaidjs.github.io/mermaid-live-editor/#/view/eyJjb2RlIjoiZ3JhcGggVEQ7XG4gICAgQS0tPkI7XG4gICAgQS0tPkM7XG4gICAgQi0tPkQ7XG4gICAgQy0tPkQ7IiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0))
## 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.mermaid]
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](LICENSE).
Copyright (c) 2018 Jan-Erik Rediger <janerik@fnordig.de>
Mermaid is [MIT licensed](https://github.com/knsv/mermaid/blob/master/LICENSE).
The bundled assets (`mermaid.css`, `mermaid.min.js`) are MIT licensed.
|
