HUGO 中文文档

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 快速上手
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 术语表
    • 配置构建
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter (前置 matter)
    • 构建选项
    • 页面资源
    • 图片处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基模板
    • 首页模板
    • 单个模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 内嵌模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • css
    • fmt
    • go 模板
    • hugo
    • js
    • lang
    • openapi3
    • os
    • urls
    • 全局
    • 加密
    • 反射
    • 变形
    • 变换
    • 哈希
    • 图像
    • 图表函数
    • 字符串
    • 安全函数
    • 局部模板函数
    • 数学
    • 数据
    • 时间
    • 模板
    • 比较
    • 类型转换
    • 编码
    • 调试
    • 资源
    • 路径
    • 集合
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Page
    • Pager
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
    • 菜单项
    • 页面
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • Images
    • 链接
    • Passthrough
    • 表格
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 编译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 故障排除
    • 本节内容
    • Audit
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • FAQs
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • Search
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitLab Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 托管在 Azure 静态 Web 应用上
    • 托管在 GitHub Pages 上
    • 托管在 KeyCDN 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
方法 页面方法

片段

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

Syntax

PAGE.Fragments

Returns

tableofcontents.Fragments
New in v0.111.0

在 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>

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

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

See also

  • 目录

On this page

  • 方法

In this section

  • Bundle类型
  • CodeOwners
  • ContentWithoutSummary
  • ExpiryDate
  • GetPage
  • GetTerms
  • Git信息
  • HasMenuCurrent
  • HasShortcode函数
  • InSection
  • IsAncestor
  • IsDescendant
  • IsHome
  • IsMenuCurrent
  • IsNode
  • IsPage
  • IsSection
  • IsTranslated
  • Lastmod
  • Len
  • LinkTitle
  • NextInSection
  • PAGE.Store
  • Plain 方法
  • PlainWords
  • PrevInSection
  • PublishDate
  • RegularPages
  • RegularPagesRecursive
  • RelPermalink
  • RelRef
  • Render
  • RenderShortcodes
  • RenderString
  • Slug
  • Truncated
  • 上一页
  • 下一个
  • 临时存储区
  • 关键词
  • 内容
  • 分页
  • 分页器
  • 别名
  • 原始内容
  • 参数
  • 参数
  • 备选输出格式
  • 多语言翻译
  • 字数统计
  • 布局
  • 引用
  • 当前章节
  • 所有翻译
  • 摘要
  • 数据
  • 文件
  • 日期
  • 权重
  • 标题
  • 标题过滤
  • 模糊字数统计
  • 永久链接
  • 父级
  • 片段
  • 目录
  • 相等性判断
  • 祖先页面
  • 种类
  • 站点
  • 站点
  • 站点地图
  • 第一节
  • 类型
  • 翻译密钥
  • 节区
  • 草稿
  • 语言
  • 资源
  • 路径
  • 输出格式
  • 部分
  • 阅读时间
  • 页面
  • 页面
  • 页面描述
Last updated: January 10, 2025: 添加 gtm 谷歌代码管理 (6220bf5)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays
 

Hugo Sponsors

Your Company?
 

The Hugo logos are copyright © Steve Francia 2013–2025.

The Hugo Gopher is based on an original work by Renée French.

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