#mdbook #preprocessor #obsidian #markdown #callouts

bin+lib mdbook-callouts

mdBook 预处理器,用于将 Obsidian Flavored Markdown 的 Callouts 添加到您的书籍中

3 个不稳定版本

0.2.1 2024 年 2 月 27 日
0.2.0 2024 年 2 月 19 日
0.1.0 2024 年 2 月 19 日

430文本处理

每月 39 次下载

MIT 许可证

1MB
121

crates.io docs.rs MIT License Build Test Audit

mdbook-callouts

mdBook 预处理器,用于将 Obsidian Flavored Markdown 的 Callouts 添加到您的书籍中,如

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

转换为

Rendered example

Rendered example 2

Rendered example 3

Rendered example 4

Rendered example 5

用法

首先,安装预处理器

cargo install mdbook-callouts

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

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

# ADD THIS
[preprocessor.callouts]

许可证

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

依赖关系

~13–24MB
~332K SLoC