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

Custom TOC marker

The default marker is:

<!-- toc -->

However that may not be everyone's favorite, if you wish to use a different such as the GitLab marker [[_TOC_]], you must add the following settings to your book.toml.

[preprocessor.toc]
marker = "[[_TOC_]]"

And for an example with the GitHub marker, which is:

* auto-gen TOC;
{:toc}

The setting is:

[preprocessor.toc]
marker = "* auto-gen TOC;\n{:toc}"

Or with multi-line strings

[preprocessor.toc]
marker = """* auto-gen TOC;
{:toc}"""

Progdrasil/mdbook-toc

mdbook-toc

Installation

Custom TOC marker

License