Find a file

Jan-Erik Rediger e8a4dac60e Ignore local testing book		2019-07-10 21:22:02 +02:00
ci	Run tests during CI	2019-07-10 14:52:14 +02:00
src	Fix test by expecting one more newline	2019-07-10 15:20:16 +02:00
.gitignore	Ignore local testing book	2019-07-10 21:22:02 +02:00
.travis.yml	Let Travis and AppVeyor deploy new releases	2019-07-10 14:14:59 +02:00
appveyor.yml	End command correctly	2019-07-10 15:29:08 +02:00
Cargo.lock	Update dependencies and refactor mdbook-toc into a preprocessor	2019-07-09 11:15:10 +02:00
Cargo.toml	Update dependencies and refactor mdbook-toc into a preprocessor	2019-07-09 11:15:10 +02:00
LICENSE	Add License and Readme	2018-07-20 12:07:21 +02:00
README.md	Update usage documentation	2019-07-10 21:15:33 +02:00
release.toml	Use cargo-release for releases	2019-07-10 21:16:36 +02:00

mdbook-toc

A preprocessor for mdbook to add inline Table of Content 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