HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 本节内容
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • 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
    • Menu entry
    • Page
    • Pager
    • Pages
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • 图像
    • 链接
    • 透传
    • 表格
  • 短代码
    • 本节内容
    • 注释
    • 详情
    • 图表
    • Gist
    • 高亮
    • Instagram
    • Param
    • QR
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo Pipes
    • 本节内容
    • 简介
    • 将 Sass 转译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资源
    • 指纹识别和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • CLI
  • 问题排查
    • 本节内容
    • 审计
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • 常见问题
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo Deploy
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure Static Web Apps 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
内容管理

链接和交叉引用

用于创建文档链接的短代码。

ref 和 relref 短代码分别显示文档的绝对和相对永久链接。

ref 和 relref 的用法

ref 和 relref 短代码需要一个参数:内容文档的路径,可以带或不带文件扩展名,可以带或不带锚点。不以 / 开头的路径首先相对于当前页面解析,然后相对于站点的其余部分解析。

.
└── content
    ├── about
    |   ├── _index.md
    |   └── credits.md
    ├── pages
    |   ├── document1.md
    |   └── document2.md    // has anchor #anchor
    ├── products
    |   └── index.md
    └── blog
        └── my-post.md

页面可以按如下方式引用

{{< ref "document2" >}}             <-- From pages/document1.md, relative path
{{< ref "document2#anchor" >}}      
{{< ref "document2.md" >}}          
{{< ref "document2.md#anchor" >}}   
{{< ref "#anchor" >}}               <-- From pages/document2.md
{{< ref "/blog/my-post" >}}         <-- From anywhere, absolute path
{{< ref "/blog/my-post.md" >}}
{{< relref "document" >}}
{{< relref "document.md" >}}
{{< relref "#anchor" >}}
{{< relref "/blog/my-post.md" >}}

index.md 可以通过其路径或其包含的目录(不带结尾的 /)引用。 _index.md 只能通过其包含的目录引用

{{< ref "/about" >}}             <-- References /about/_index.md
{{< ref "/about/_index" >}}      <-- Raises REF_NOT_FOUND error
{{< ref "/about/credits.md" >}}  <-- References /about/credits.md

{{< ref "/products" >}}          <-- References /products/index.md
{{< ref "/products/index" >}}    <-- References /products/index.md

要在 Markdown 中使用 ref 或 relref 生成超链接

[About]({{< ref "/about" >}} "About Us")

如果无法唯一解析文档,Hugo 会发出错误或警告。错误行为是可配置的;请参见下文。

链接到另一个语言版本

使用 ref 或 relref 而不指定语言,将使引用解析为当前内容页面的语言。

要链接到文档的另一个语言版本,请使用此语法

{{< relref path="document.md" lang="ja" >}}

获取另一种输出格式

要链接到文档的另一种输出格式,请使用此语法

{{< relref path="document.md" outputFormat="rss" >}}

标题 ID

使用 Markdown 文档类型时,Hugo 会为页面上的每个标题生成元素 ID。例如

## Reference

生成此 HTML

<h2 id="reference">Reference</h2>

在使用 ref 或 relref 短代码时,通过将 ID 附加到路径来获取标题的永久链接

{{< ref "document.md#reference" >}}
{{< relref "document.md#reference" >}}

通过包含属性来生成自定义标题 ID。例如

## Reference A {#foo}
## Reference B {id="bar"}

生成此 HTML

<h2 id="foo">Reference A</h2>
<h2 id="bar">Reference B</h2>

如果同一标题在页面上出现多次,Hugo 将生成唯一的元素 ID。例如

## Reference
## Reference
## Reference

生成此 HTML

<h2 id="reference">Reference</h2>
<h2 id="reference-1">Reference</h2>
<h2 id="reference-2">Reference</h2>

Ref 和 RelRef 配置

可以在 hugo.toml 中配置该行为

refLinksErrorLevel (“ERROR”)
当使用 ref 或 relref 解析页面链接并且无法解析链接时,将使用此日志级别记录。有效值为 ERROR(默认值)或 WARNING。任何 ERROR 都会使构建失败 (exit -1)。
refLinksNotFoundURL
当在 ref 或 relref 中找不到页面引用时,用作占位符的 URL。按原样使用。

另请参阅

  • URL管理

在此页面上

  • ref 和 relref 的用法
  • Ref 和 RelRef 配置
上次更新时间:2025 年 1 月 16 日: 将目录名称、文件名和文件路径格式化为代码 (8051ff818)
改进此页面
由 Hugo 作者
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

您的公司?
 

Hugo 徽标的版权归 © Steve Francia 2013-2025 所有。

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

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