Reference

book.toml configuration
Directives

`book.toml` configuration

See below for all configuration options available to add in book.toml.

The options should all be nested under preprocessor.admonish; for example:

[preprocessor.admonish]
on_failure = "bail"

[preprocessor.admonish.default]
collapsible = true

[preprocessor.admonish.renderer.test]
render_mode = "strip"

`on_failure`

Optional. Default value: continue.

The action to take when an invalid admonish block is encountered:

continue (default): Continue processing future blocks, do not fail the build. If rendering to HTML, an error message will be displayed in the book output.
bail: Abort the build.

`default`

Optional.

Default values to use, when not provided in an admonish block explicitly.

Subfields:

default.title (optional): Title to use for blocks. Defaults to the directive used in titlecase.
default.collapsible (optional, default: false): Make blocks collapsible by default when set to true.
default.css_id_prefix (optional, default: "admonition-"): The default css id prefix to add to the id of all blocks. Ignored on blocks with an id field.

`renderer`

Tip

It is recommended that you set:

[preprocessor.admonish.renderer.test]
render_mode = "strip"

This allows mdbook test to find and test rust examples within admonish blocks.

This will be the default behaviour in the next mdbook-admonish major version.

Optional.

Additional settings to apply, depending on the renderer that is running.

The most common renderers used are:

html: Used by mdbook build to build the final book output.
test: Used by mdbook test to find and run doctests.

Subfields:

renderer.<renderer_name>.render_mode (optional): The action mdbook-admonish should take when running with this renderer.
- Valid values:
  - html: Convert admonish blocks into HTML output.
  - preserve: Do nothing. Leave the book untouched.
  - strip: Strip admonish-specific syntax, leaving the inner content untouched.
- Default values:
  - For the html renderer, the default value is html.
  - For all other renderers, the default value is preserve.

`directive`

Optional.

Settings relating to each type of block.

`builtin`

Optional.

Override the settings of a builtin directive.

The subkey of builtin is the directive to override. This must be the first directive listed in the Directives section below, e.g. warning (not caution or other aliases).

[preprocessor.admonish.directive.builtin.warning]
collapsible = true

Subfields:

collapsible (optional): The default boolean value of the collapsible property for this type of block.

`custom`

Optional.

Additional types of block to support. The subkey of custom is the new directive to support.

You must run mdbook-admonish generate-custom after updating these values, to generate the correct styles.

[preprocessor.admonish.directive.custom.expensive]
icon = "./money-bag.svg"
color = "#24ab38"
collapsible = true
aliases = ["money", "cash", "budget"]

Subfields:

icon: A filepath relative to the book root to load an SVG icon from.
color: An RGB hex encoded color to use for the icon.
collapsible (optional): The default boolean value of the collapsible property for this type of block.
aliases (optional): One or more alternative directives to use this block.
title (optional): The default title for this type of block. If not specified, defaults to the directive in title case. To give each alias a custom title, add multiple custom blocks.

`command`

Required.

Used by mdbook to know how to call the mdbook-admonish plugin.

Running this command with the --version flag from your shell should work, for the plugin to function.

`assets_version`

Optional.

This is automatically updated by mdbook-admonish install and should not be edited.

Directives

All supported directives are listed below.

Custom directives can be added via the custom config option above.

note

Note