Find a file

NBonaparte f8f09d441e Generate unique slugs for identically named headers		2021-01-06 13:52:21 +01:00
.github/workflows	Switch to GitHub Actions	2021-01-05 20:41:11 +01:00
src	Generate unique slugs for identically named headers	2021-01-06 13:52:21 +01:00
.gitignore	Ignore local testing book	2019-07-10 21:22:02 +02:00
Cargo.lock	(cargo-release) start next development iteration 0.5.2-alpha.0	2020-09-28 17:47:37 +02:00
Cargo.toml	(cargo-release) start next development iteration 0.5.2-alpha.0	2020-09-28 17:47:37 +02:00
LICENSE	Add License and Readme	2018-07-20 12:07:21 +02:00
README.md	Update license notice	2020-04-06 10:39:07 +02:00
release.toml	Set tag-name to not include the `v`	2019-08-21 09:52:41 -07:00

mdbook-toc

A preprocessor for mdbook to add inline Table of Contents support.

It turns this:

<!-- toc -->

into a Table of Contents based on all top- and second-level headings of the chapter.

Installation

If you want to use only this preprocessor, install the tool:

cargo install mdbook-toc

Add it as a preprocessor to your book.toml:

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

Finally, build your book as normal:

mdbook path/to/book