README.md

mdbook-alerts

mdBook preprocessor to add GitHub Flavored Markdown's Alerts to your book like:

> [!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.

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

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

into

Usage

First, install the preprocessor:

cargo install mdbook-alerts

Then, add the preprocessor to your book.toml:

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

# ADD THIS
[preprocessor.alerts]

License

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