mdbook-indexing

为mdbook提供索引构建支持的预处理器。

• 在{{i:<text>}}中包含的短语将原样传输到渲染输出，同时也会为它们添加索引条目。
• 在{{ii:<text>}}中包含的短语将作为斜体传输到渲染输出，同时也会为它们添加索引条目。
• 在{{hi:<text>}}中包含的短语将从渲染输出中删除，但仍然会为它们添加索引条目。
• 名称为索引的任何章节的内容将被索引的累积内容替换。
  • 请注意，最好不要使用index.md作为索引的文件名，因为这将成为index.html，并最终成为书籍的默认着陆页。为文件使用替代名称（例如，indexing.md）可以避免这种情况。

安装

要使用，安装工具

cargo install mdbook-indexing

并将其添加到book.toml中的预处理器

[preprocessor.indexing]

配置

参见

[preprocessor.indexing.see_instead]部分中的键值对表示索引条目，其中键应指向值。因此，以下条目

"unit type" = "`()`"

将导致索引条目显示为：“单元类型，参见 ()”（而不是位置列表）。

嵌套条目

配置文件 [preprocessor.indexing.nest_under] 部分的键值对表示索引条目，其中键的条目应该嵌套在值下。因此，如下的条目

"generic type" = "generics"

将导致“泛型类型”的索引条目仅作为缩进的子条目列在“泛型”下。

章节名称

use_chapter_names 布尔配置选项启用了一种模式，其中生成的索引使用索引条目所在的章节名称，而不是仅使用数字。

局限性

• 避免将索引放在链接内部，因为它会破坏链接，即优先选择

  {{i:[text](http:link)}}
  

  而不是

  [{{i:text}}](http:link)