mdbook-readme-summary

用例

当你使用 mdbook 并且你有以下文件结构时

. └── src/ ├── subdirectory1/ │ ├── subdirectory1.1/ │ │ ├── file1.md │ │ ├── ... │ │ └── README.md │ ├── file1.md │ ├── file2.md │ ├── ... │ └── README.md ├── subdirectory2/ │ ├── file1.md │ ├── file2.md │ ├── ... │ └── README.md ├── ... └── README.md

并且你希望在每个子目录的 README 中显示该目录的内容的表格。

用法

运行

cargo install mdbook-readme-summary

在你的 README.md 文件中，在期望的位置添加 {{TOC}}

在你的 book.toml 中添加

[preprocessor.readme-summary]

你可以使用两种配置

[preprocessor.readme-summary]
enable-draft = true
enable-log = true

默认情况下，此预处理器会自动忽略包含关键字 "(草案)" 的文件和目录。将 enable-draft 设置为 true 将禁用此忽略。

将 enable-log 设置为 true 将显示一些调试信息。