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 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
CONTENT MANAGEMENT

链接和交叉引用

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

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

ref 和 relref 的用法

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

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

页面可以按如下方式引用:

{{< ref "document2" >}}             <-- 从 pages/document1.md,相对路径
{{< ref "document2#anchor" >}}      
{{< ref "document2.md" >}}          
{{< ref "document2.md#anchor" >}}   
{{< ref "#anchor" >}}               <-- 从 pages/document2.md
{{< ref "/blog/my-post" >}}         <-- 从任何位置,绝对路径
{{< ref "/blog/my-post.md" >}}
{{< relref "document" >}}
{{< relref "document.md" >}}
{{< relref "#anchor" >}}
{{< relref "/blog/my-post.md" >}}

index.md 可以通过其路径或其包含的文件夹(不包含结尾的 / )来引用。 _index.md 只能通过其包含的文件夹来引用:

{{< ref "/about" >}}             <-- 引用 /about/_index.md
{{< ref "/about/_index" >}}      <-- 产生 REF_NOT_FOUND 错误
{{< ref "/about/credits.md" >}}  <-- 引用 /about/credits.md

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

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

[关于]({{< ref "/about" >}} "关于我们")

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

链接到其他语言版本

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

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

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

获取其他输出格式

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

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

标题 ID

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

## 参考 {#reference}

生成以下 HTML:

<h2 id="reference">参考</h2>

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

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

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

## 参考 A {#foo}
## 参考 B {id="bar"} {#reference-b-id-bar}

生成以下 HTML:

<h2 id="foo">参考 A</h2>
<h2 id="bar">参考 B</h2>

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

## 参考 {#reference}
## 参考 {#reference}
## 参考 {#reference}

生成以下 HTML:

<h2 id="reference">参考</h2>
<h2 id="reference-1">参考</h2>
<h2 id="reference-2">参考</h2>

Ref 和 RelRef 配置

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

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

On this page

  • ref 和 relref 的用法
  • Ref 和 RelRef 配置
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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护