mdbook-callouts

mdBook preprocessor to add Obsidian Flavored Markdown's Callouts to your book like:

> [!INFO]
> Highlights information of additional information that users should take into
> account, even when skimming.

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!SUCCESS]
> Success information to a user.

> [!QUESTION]
> Question for the user to consider.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

> [!FAILURE]
> Information about a failure.

> [!DANGER]
> Information about a danger or a hazardous situation that users need to avoid.

> [!BUG]
> Information about a bug or an issue that users need to be aware of.

> [!EXAMPLE]
> Example of a point or solution that users can apply.

> [!QUOTE]
> Quoted information that is particularly relevant or insightful.

> [!QUOTE] Custom title example
> You can set a custom title by adding the title in the same line as the tag.

into

Usage

First, install the preprocessor:

cargo install mdbook-callouts

Then, add the preprocessor to your book.toml:

[book]
authors = ["Alisue"]
language = "en"
multilingual = false
src = "src"
title = "mdBook Alerts preprocessor"

# ADD THIS
[preprocessor.callouts]

License

The code follows the MIT license written in LICENSE. Contributors need to agree that any modifications sent to this repository follow the license.