#mdbook #github #preprocessor #markdown

bin+lib mdbook-alerts

为您的书籍添加 GitHub Flavored Markdown 的警告的 mdBook 预处理器

11 个版本 (5 个重大更改)

新增 0.6.3 2024年8月12日
0.6.1 2024年7月29日
0.4.0 2024年1月14日

#353 in 文本处理

Download history 56/week @ 2024-04-24 45/week @ 2024-05-01 52/week @ 2024-05-08 194/week @ 2024-05-15 42/week @ 2024-05-22 38/week @ 2024-05-29 28/week @ 2024-06-05 13/week @ 2024-06-12 12/week @ 2024-06-19 231/week @ 2024-06-26 153/week @ 2024-07-03 168/week @ 2024-07-10 94/week @ 2024-07-17 366/week @ 2024-07-24 296/week @ 2024-07-31 233/week @ 2024-08-07

每月下载量 1,027

MIT 许可证

60KB
112 代码行

crates.io docs.rs MIT License Build Test Audit

mdbook-alerts

mdBook 预处理器,可以将 GitHub Flavored Markdown 的警告 添加到您的书籍中,如下所示

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

变成

Rendered example

用法

首先,安装预处理器

cargo install mdbook-alerts

然后,将预处理器添加到您的 book.toml

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

# ADD THIS
[preprocessor.alerts]

许可证

代码遵循 LICENSE 中编写的 MIT 许可证。贡献者需要同意发送到该存储库的任何修改都遵循此许可证。

依赖项

~13–23MB
~327K SLoC