mdbook-admonish

A preprocessor for mdbook to add Material UI admonishments.

It turns this:

```admonish info
A beautifully styled message.
```

into this:

Styling is based on mkdocs-material.

Usage

Use any fenced code-block as you normally would, but annotate it with admonish <admonition type>:

```admonish example
My example is the best!
```

You can also leave out the admonition type, in which case it will default to note:

```admonish
A plain note.
```

See the mkdocs-material docs for a list of supported admonitions. You'll fine:

• info
• warning
• danger
• example

and quite a few more!

Installation

Install the tool:

cargo install mdbook-admonish

Then let mdbook-admonish add the required files and configuration:

mdbook-admonish install path/to/your/book

# optionally, specify a directory where CSS files live, relative to the book root
mdbook-admonish install --css-dir ./assets/css .

This will add the following configuration to your book.toml:

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

[output.html]
additional-css = ["./mdbook-admonish.css"]

and copy the file mdbook-admonish.css into your book's directory.

Then, build your book as usual:

mdbook path/to/book

Development

Project design

• Compiled CSS styles are built and committed from SCSS sources. See the compile_assets folder for details.
• mdbook-admonish install is responsible for delivering additional assets and configuration to a client book.
• mdbook-admonish is responsible for preprocessing book data, adding HTML that references compiled classnames.

Thanks

This utility is heavily drawn from and inspired by other projects, namely:

• mdbook-mermaid
• mkdocs-material
• material-design-icons

The licences for these projects are included in the licences folder.