#mdbook #toc

bin+lib mdbook-toc

mdbook preprocessor to add Table of Contents

27 releases (12 breaking)

0.14.1 Aug 5, 2023
0.13.0 Jul 18, 2023
0.11.2 Feb 14, 2023
0.11.0 Dec 15, 2022
0.2.1 Jul 16, 2019

#183 in Text processing

Download history 428/week @ 2023-06-01 453/week @ 2023-06-08 415/week @ 2023-06-15 443/week @ 2023-06-22 434/week @ 2023-06-29 402/week @ 2023-07-06 576/week @ 2023-07-13 658/week @ 2023-07-20 633/week @ 2023-07-27 695/week @ 2023-08-03 502/week @ 2023-08-10 654/week @ 2023-08-17 612/week @ 2023-08-24 548/week @ 2023-08-31 659/week @ 2023-09-07 449/week @ 2023-09-14

2,367 downloads per month
Used in mdbook-dtmo

MPL-2.0 license

30KB
250 lines

mdbook-toc

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

It turns this marker:

<!-- toc -->

into a Table of Contents based on headings of the chapter following the marker.

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

Configuration

Custom TOC marker

The default marker is:

<!-- toc -->

If you wish to use a different marker, such as the GitLab marker [[_TOC_]], you must add the following settings to your book.toml.

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

You can also use multi-line markers such as the GitHub marker, which is:

* auto-gen TOC;
{:toc}

Configure the string with a newline:

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

or with multi-line strings:

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

Maximum header level

By default the ToC will include headings up to level 4 (####). This can be configured in your book.toml as follows:

[preprocessor.toc]
max-level = 4

License

MPL. See LICENSE.
Copyright (c) 2018-2020 Jan-Erik Rediger janerik@fnordig.de

Dependencies

~10–47MB
~727K SLoC