mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-05 00:32:03 +00:00
![Bjørn Erik Pedersen](/assets/img/avatar_default.png)
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
1.1 KiB
1.1 KiB
title | description | categories | keywords | action | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
TableOfContents | Returns a table of contents for the given page. |
|
The TableOfContents
method on a Page
object returns an ordered or unordered list of the markdown ATX and setext headings within the page content.
This template code:
{{ .TableOfContents }}
Produces this HTML:
<nav id="TableOfContents">
<ul>
<li><a href="#section-1">Section 1</a>
<ul>
<li><a href="#section-11">Section 1.1</a></li>
<li><a href="#section-12">Section 1.2</a></li>
</ul>
</li>
<li><a href="#section-2">Section 2</a></li>
</ul>
</nav>
By default, the TableOfContents
method returns an unordered list of level 2 and level 3 headings. You can adjust this in your site configuration:
{{< code-toggle file=hugo >}} [markup.tableOfContents] endLevel = 3 ordered = false startLevel = 2 {{< /code-toggle >}}