Awesome Asciidoctor: Leave Section Titles Out of Table Of Contents

Section titles in our document (titles start with two or more equals signs) are part of the document hierarchy and therefore can be used in a generated table of contents. If we don't want to include a section title in the table of contents we must make the title discrete. The title is styled like a normal section title, but it is no longer part of the document structure as title. Therefore the section title will not be generated in the table of contents. To make a title discrete we must use the attribute discrete for the title.

In the following document we first have a simple document with two section titles. When we generate the HTML for this document we see both titles in the table of contents.

?

1 2 3 4 5 6 7 8 9

:toc: = Section example   == Introduction   Simple introduction section.   == More   There is more information in this document.

Now we make the first section title discrete by applying the discrete attribute:

?

1 2 3 4 5 6 7 8 9 10

:toc: = Section example   [discrete] == Introduction   Simple introduction section.   == More   There is more information in this document.

We generate the document again as HTML and this time we see the section title is no longer in the table of contents:

Written with Asciidoctor 1.5.2.