Table of Contents

Automatic Table of Contents

Table of Contents

Generate a table of contents automatically from your page headings.

How to Add a ToC

Insert this macro in your Markdown file:

<!-- MACRO{toc|fromDepth=2|toDepth=3|id=toc} -->

Important

The id=toc parameter is required for proper styling.

Parameter	Description	Default
`fromDepth`	Starting heading level (1 = h1)	1
`toDepth`	Ending heading level (2 = h2)	2
`id`	Must be `toc` to be handled by the skin	Required

A document with these headings:

# Page Title
## Section One
### Subsection
## Section Two

With fromDepth=1 and toDepth=2, the ToC includes:

(Subsection is excluded because it's level 3)

Setting	Description	Default
`tocSelector`	CSS selector for the ToC element	`ul#toc`
`fixHeadings`	Enhance headings with proper IDs, and anchor links	`true`

If you use a different ID or structure for your ToC:

Site-Wide (site.xml)

Site-Wide (site.xml)

<custom>
  <tocSelector>ul#my-custom-toc</tocSelector>
</custom>

Per-Page (Frontmatter)

Per-Page (Frontmatter)

tocSelector: ul#my-custom-toc

# My Page

<!-- MACRO{toc|fromDepth=2|toDepth=3|id=my-custom-toc} -->

To disable the enhanced headings and automatic anchor links:

Site-Wide (site.xml)

Site-Wide (site.xml)

<custom>
  <fixHeadings>false</fixHeadings>
</custom>

Per-Page (Frontmatter)

Per-Page (Frontmatter)

fixHeadings: false

# Plain Headings

Headings won't have clickable anchor links and their internal ID will use pre-HTML5 syntax.

See Maven Doxia macros^[1] for more details.

Searching...

No results.