片段
Syntax
PAGE.Fragments
Returns
tableofcontents.Fragments
在 URL 中,无论是绝对 URL 还是相对 URL, 片段 都链接到页面上 HTML 元素的 id
属性。
/articles/article-1#section-2
------------------- ---------
路径 片段
Hugo 为页面内容中的每个 Markdown ATX 和 setext 标题分配一个 id
属性。您可以根据需要使用 Markdown 属性 覆盖 id
。这创建了 目录 (TOC) 中的条目与页面上标题之间的关系。
使用 Page
对象上的 Fragments
方法创建目录,可以使用 Fragments.ToHTML
方法,或通过 遍历 Fragments.Map
数据结构。
方法
- 标题
- (
slice
) 页面上所有标题的映射切片,每个标题的第一级键。每个映射包含以下键:ID
、Level
、Title
和Headings
。要检查数据结构:
<pre>{{ debug.Dump .Fragments.Headings }}</pre>
- 标题映射
- (
map
) 页面上所有标题的嵌套映射。每个映射包含以下键:ID
、Level
、Title
和Headings
。要检查数据结构:
<pre>{{ debug.Dump .Fragments.HeadingsMap }}</pre>
- 标识符
- (
slice
) 包含页面上每个标题的id
的切片。要检查数据结构:
<pre>{{ debug.Dump .Fragments.Identifiers }}</pre>
- Identifiers.Contains ID
- (
bool
) 报告页面上一个或多个标题是否具有给定的id
属性,这对于验证链接中的片段很有用 渲染钩子 。
{{ .Fragments.Identifiers.Contains "section-2" }} → true
- Identifiers.Count ID
- (
int
) 页面上具有给定id
属性的标题数量,用于检测重复项。
{{ .Fragments.Identifiers.Count "section-2" }} → 1
- ToHTML
- (
template.HTML
) 返回作为嵌套列表的 TOC,有序或无序,与TableOfContents
方法返回的 HTML 相同。此方法采用三个参数:起始级别(int
)、结束级别(int
)和布尔值(true
返回有序列表,false
返回无序列表)。
当您想独立于站点配置中的目录设置来控制起始级别、结束级别或列表类型时,请使用此方法。
{{ $startLevel := 2 }}
{{ $endLevel := 3 }}
{{ $ordered := true }}
{{ .Fragments.ToHTML $startLevel $endLevel $ordered }}
Hugo 将其渲染为:
<nav id="TableOfContents">
<ol>
<li><a href="#section-1">Section 1</a>
<ol>
<li><a href="#section-11">Section 1.1</a></li>
<li><a href="#section-12">Section 1.2</a></li>
</ol>
</li>
<li><a href="#section-2">Section 2</a></li>
</ol>
</nav>