mdBook清单预处理器

用于收集mdBook中的检查项并生成索引的预处理器。

用法

首先，您需要安装预处理器

cargo install mdbook-checklist

然后，您需要将预处理器添加到您的 book.toml

[book]
authors = ["Me"]
multilingual = false
src = "src"
title = "The Book"

[preprocessor.checklist]

最后，您可以在书章节中插入标记，格式如下： {{#check <name> | <description>}}. 例如

# Chapter 1

{{#check Note-1 | This is an important note}}

标记将被名称（带有从索引链接的锚点）替换。对于此示例，以下索引将被生成

清单

• 第一章
  • 这是一个重要的注意事项 (注意事项-1)

选项

生成的索引的标题 Checklist 可以更改

[preprocessor.checklist]
title = "A list of notes"

许可协议

此库在 Open Licence 2.0 许可协议下发布。