Reference
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 totrue
.default.css_id_prefix
(optional, default:"admonition-"
): The default css id prefix to add to the id of all blocks. Ignored on blocks with anid
field.
renderer
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 bymdbook build
to build the final book output.test
: Used bymdbook test
to find and run doctests.
Subfields:
renderer.<renderer_name>.render_mode
(optional): The actionmdbook-admonish
should take when running with this renderer.- Valid values:
html
: Convertadmonish
blocks into HTML output.preserve
: Do nothing. Leave the book untouched.strip
: Stripadmonish
-specific syntax, leaving the inner content untouched.
- Default values:
- For the
html
renderer, the default value ishtml
. - For all other renderers, the default value is
preserve
.
- For the
- Valid values:
custom
Optional.
Additional type of block to support.
You must run mdbook-admonish generate-custom
after updating these values, to generate the correct styles.
Add blocks using TOML's Array of Tables notation:
[[preprocessor.admonish.custom]]
directive = "expensive"
icon = "./money-bag.svg"
color = "#24ab38"
aliases = ["money", "cash", "budget"]
Subfields:
directive
: The keyword to use this type of block.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.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
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
abstract
, summary
, tldr
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
info
, todo
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
tip
, hint
, important
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
success
, check
, done
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
question
, help
, faq
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
warning
, caution
, attention
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
failure
, fail
, missing
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
danger
, error
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
bug
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
example
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
quote
, cite