mdBook

mdBook Documentation

mdbook-mermaid

mdbook-mermaid

Installation

docker run --rm -i -t -v "./example:/book" --entrypoint sh "peaceiris/mdbook:v0.4.40-arm64"
mdbook-mermaid install /book

book.toml

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

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

Example

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

mdbook-toc

badboy/mdbook-toc: A preprocessor for mdbook to add inline Table of Contents support.

• Installation
• Example

Installation

book.toml

[preprocessor.toc]
command = "mdbook-toc"
renderer = ["html"]

Example

<!-- toc -->

Admonitions (Built-in)

mdBook 0.5 has built-in support for admonitions using blockquote syntax.

Admonitions - The mdBook Documentation

Examples

Note

A beautifully styled message.

Tip

My example is the best!

Note

A plain note.

Warning

Data loss

The following steps can lead to irrecoverable data corruption.

Tip

Referencing and dereferencing

The opposite of referencing by using & is dereferencing, which is accomplished with the dereference operator, *.

Caution

This syntax won’t work in Python 3:

print "Hello, world!"

Note

Sneaky

Content will be hidden initially.