mdbook-toc

为 mdbook 添加内联目录支持的预处理器。

它将这个标记

<!-- toc -->

转换为基础章节标题的目录。

安装

如果您只想使用此预处理器，请安装该工具

cargo install mdbook-toc

将其添加到您的 book.toml 中的预处理器列表

[preprocessor.toc]
command = "mdbook-toc"
renderer = ["html"]

最后，像平常一样构建您的书籍

mdbook path/to/book

配置

自定义目录标记

默认标记为

<!-- toc -->

如果您想使用不同的标记，例如 GitLab 标记 [[_TOC_]]，您必须在您的 book.toml 中添加以下设置。

[preprocessor.toc]
marker = "[[_TOC_]]"

您还可以使用多行标记，例如 GitHub 标记，如下所示

* auto-gen TOC;
{:toc}

使用换行符配置字符串

[preprocessor.toc]
marker = "* auto-gen TOC;\n{:toc}"

或使用多行字符串

[preprocessor.toc]
marker = """* auto-gen TOC;
{:toc}"""

最大标题级别

默认情况下，目录将包括直到第 4 级标题（####）。这可以在您的 book.toml 中如下配置

[preprocessor.toc]
max-level = 4

许可证

MPL. 请参阅 LICENSE.
版权 (c) 2018-2020 Jan-Erik Rediger janerik@fnordig.de