Table of contents (ToC)

OurBigBook automatically adds a table of contents at the end of the first non-toplevel header of every document.

For example, on a standard document with a single toplevel header:

= Animal

Animals are cute!

== Dog

== Cat

the ToC is rendered something like:

= Animal

Animals are cute!

Table of Contents
* Dog
* Cat

== Dog

== Cat

The ToC ignores the toplevel header if you have one.

Use tocMaxEntries to limit the size of static tables of contents by removing whole depth levels.

For when you want a quick outline of the header tree on the terminal, also consider the --log headers option.

 Ancestors (4)