#mdbook #github #preprocessor #markdown

bin+lib mdbook-alerts

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

8 releases (5 breaking)

new 0.6.0 Jul 15, 2024
0.5.2 Jun 26, 2024
0.5.1 May 18, 2024
0.5.0 Apr 20, 2024
0.1.0 Jan 14, 2024

#424 in Text processing

Download history 43/week @ 2024-04-01 3/week @ 2024-04-08 148/week @ 2024-04-15 64/week @ 2024-04-22 35/week @ 2024-04-29 46/week @ 2024-05-06 206/week @ 2024-05-13 46/week @ 2024-05-20 45/week @ 2024-05-27 30/week @ 2024-06-03 10/week @ 2024-06-10 18/week @ 2024-06-17 208/week @ 2024-06-24 167/week @ 2024-07-01 58/week @ 2024-07-08

452 downloads per month

MIT license

60KB
112 lines

crates.io docs.rs MIT License Build Test Audit

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

Rendered example

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.

Dependencies

~13–24MB
~331K SLoC