TableOfContents
返回给定页面的目录。
Syntax
PAGE.TableOfContents
Returns
template.HTML
Page 对象上的 TableOfContents 方法返回页面内容内 Markdown ATX 和 setext 标题的有序或无序列表。
此模板代码:
{{ .TableOfContents }}生成此 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>默认情况下,TableOfContents 方法返回 2 级和 3 级标题的无序列表。您可以在站点配置中调整此设置:
markup:
tableOfContents:
endLevel: 3
ordered: false
startLevel: 2
[markup]
[markup.tableOfContents]
endLevel = 3
ordered = false
startLevel = 2
{
"markup": {
"tableOfContents": {
"endLevel": 3,
"ordered": false,
"startLevel": 2
}
}
}