HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 本节内容
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • 前置内容
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基础模板
    • 主页模板
    • 单页模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hash
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • 方法
    • 本节内容
    • Duration
    • Menu
    • 菜单项
    • 页面
    • 分页器
    • 页面集
    • 资源
    • 短代码
    • 站点
    • 分类法
    • 时间
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • 图片
    • 链接
    • 透传
    • 表格
  • 短代码
    • 本节内容
    • 注释
    • 详情
    • 图示
    • Gist
    • 高亮
    • Instagram
    • Param
    • QR
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 转译为 CSS
    • PostCSS
    • 后处理
    • JavaScript 构建
    • 资源压缩
    • 连接资源
    • 指纹识别和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • CLI
  • 故障排除
    • 本节内容
    • 审计
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • 常见问题
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure Static Web Apps 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
方法 页面方法

片段

返回给定页面中片段的数据结构。

语法

PAGE.Fragments

返回值

tableofcontents.Fragments

在 URL 中,无论是绝对 URL 还是相对 URL,片段链接到页面上 HTML 元素的 id 属性。

/articles/article-1#section-2
------------------- ---------
       path         fragment

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>
HeadingsMap
(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>

即使对于当前页面,也可以安全地在渲染钩子中使用 Fragments 方法。

在短代码中使用 Fragments 方法时,请使用 {{< >}} 表示法调用短代码。 如果使用 {{% %}} 表示法,则渲染的短代码将包含在片段映射的创建中,从而导致循环。

另请参阅

  • TableOfContents

本页内容

  • 方法

本节内容

  • 别名
  • AllTranslations
  • AlternativeOutputFormats
  • Ancestors
  • BundleType
  • CodeOwners
  • Content
  • ContentWithoutSummary
  • CurrentSection
  • Data
  • Date
  • Description
  • Draft
  • Eq
  • ExpiryDate
  • File
  • FirstSection
  • 片段
  • FuzzyWordCount
  • GetPage
  • GetTerms
  • GitInfo
  • HasMenuCurrent
  • HasShortcode
  • HeadingsFiltered
  • InSection
  • IsAncestor
  • IsDescendant
  • IsHome
  • IsMenuCurrent
  • IsNode
  • IsPage
  • IsSection
  • IsTranslated
  • Keywords
  • Kind
  • Language
  • Lastmod
  • Layout
  • Len
  • LinkTitle
  • Next
  • NextInSection
  • OutputFormats
  • 页面
  • PAGE.Store
  • 页面集
  • Paginate
  • Paginator
  • Param
  • Params
  • Parent
  • Path
  • Permalink
  • Plain
  • PlainWords
  • Prev
  • PrevInSection
  • PublishDate
  • RawContent
  • ReadingTime
  • Ref
  • RegularPages
  • RegularPagesRecursive
  • RelPermalink
  • RelRef
  • Render
  • RenderShortcodes
  • RenderString
  • Resources
  • Scratch
  • Section
  • 章节
  • 站点
  • Sitemap
  • Sites
  • Slug
  • Summary
  • TableOfContents
  • Title
  • TranslationKey
  • Translations
  • Truncated
  • Type
  • Weight
  • WordCount
最后更新时间:2025 年 1 月 16 日:删除过时的新增徽章 (8c1debf3a)
改进此页面
由 Hugo 作者撰写
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

您的公司?
 

Hugo 标志的版权归 Steve Francia 2013–2025 所有。

Hugo Gopher 基于 Renée French 的原创作品。

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 入门
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • 短代码
  • Hugo 模块
  • Hugo 管道
  • CLI
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护