A preprocessor that generates a summary from the file structure of your book rather than using an explicit SUMMARY.md file.
Frequently, you want the organization of your files to simply be mirrored in the SUMMARY.md file rather than have to manually set it yourself. We can automate this by following a few conventions:
00.md04_cli.md comes before 05_agile.md and the 05_team folder comes before the 06_docs folder._shared.md) and should not be included in the table of contents. You can also use an underscore to create a "draft".H1 header of the page. An error is thrown if there is no title.These conventions should create a filesystem structure that, when sorted alphanumerically, is the same in the final render.
01_intro.md
02_install.md/
├─ 00.md
├─ 01_linux.md
├─ 02_mac.md
├─ 03_windows.md
├─ _common_install_tips.md
03_caveat.md
04_usage.md/
├─ 00.md
├─ 01_basics.md/
│ ├─ 00.md
│ ├─ 01_setup.md
│ ├─ 02_monitoring.md
You must create a dummy SUMMARY.md, otherwise mdbook will error out before the preprocessors get called. (The contents aren't important. It can just have # SUMMARY as the first line.)
Install the project with cargo. The current version is v0.1.2.
cargo install mdbook-fs-summary
There are no configurable options right now.
```toml
[preprocessor.fs-summary] ```
SUMMARY.md.