HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio 加星
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门指南
    • 本节内容
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • 前言
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基础模板
    • 首页模板
    • 单页模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go 模板
    • 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
    • 参数
    • QR
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo Pipes
    • 本节内容
    • 简介
    • 将 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 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
渲染钩子

链接渲染钩子

创建一个链接渲染钩子来覆盖将 Markdown 链接渲染为 HTML 的过程。

Markdown

一个 Markdown 链接有三个组成部分:链接文本、链接目标,以及可选的链接标题。

[Post 1](/posts/post-1 "My first post")
 ------  -------------  -------------
  text    destination       title

这些组成部分作为如下所示的渲染钩子上下文传入。

上下文

链接渲染钩子模板接收以下上下文

目标

(string)链接目标。

页面

(page)对当前页面的引用。

PageInner
v0.125.0 中的新增功能

(page)通过 RenderShortcodes 方法嵌套的页面的引用。查看详情。

PlainText

(string)链接描述的纯文本。

Text

(template.HTML)链接描述。

Title

(string)链接标题。

示例

对于诸如图像和链接之类的内联元素,请使用 {{‑ ‑}} 分隔符表示法删除开头和结尾的空格,以防止相邻的内联元素和文本之间出现空格。

在其默认配置中,Hugo 根据CommonMark 规范渲染 Markdown 链接。要创建一个执行相同操作的渲染钩子

layouts/_default/_markup/render-link.html
<a href="{{ .Destination | safeURL }}"
  {{- with .Title }} title="{{ . }}"{{ end -}}
>
  {{- with .Text }}{{ . }}{{ end -}}
</a>
{{- /* chomp trailing newline */ -}}

要为外部链接包含一个设置为 external 的 rel 属性

layouts/_default/_markup/render-link.html
{{- $u := urls.Parse .Destination -}}
<a href="{{ .Destination | safeURL }}"
  {{- with .Title }} title="{{ . }}"{{ end -}}
  {{- if $u.IsAbs }} rel="external"{{ end -}}
>
  {{- with .Text }}{{ . }}{{ end -}}
</a>
{{- /* chomp trailing newline */ -}}

默认

v0.123.0 中的新增功能

Hugo 包含一个嵌入式链接渲染钩子来解析 Markdown 链接目标。默认情况下禁用,您可以在站点配置中启用它

hugo。
     
markup:
  goldmark:
    renderHooks:
      link:
        enableDefault: true
[markup]
  [markup.goldmark]
    [markup.goldmark.renderHooks]
      [markup.goldmark.renderHooks.link]
        enableDefault = true
{
   "markup": {
      "goldmark": {
         "renderHooks": {
            "link": {
               "enableDefault": true
            }
         }
      }
   }
}

自定义渲染钩子,即使由主题或模块提供,也会覆盖嵌入式渲染钩子,而不管上述配置设置如何。

如果禁用共享页面资源的复制,则对于多语言单主机站点,会自动启用嵌入式链接渲染钩子。这是多语言单主机站点的默认配置。

嵌入式链接渲染钩子通过查找匹配的页面来解析内部 Markdown 目标,回退到匹配的页面资源,然后回退到匹配的全局资源。远程目标将直接传递,如果无法解析目标,渲染钩子不会引发错误或警告。

您必须将全局资源放置在 assets 目录中。如果您已将资源放置在 static 目录中,并且您无法或不愿移动它们,您必须通过在您的站点配置中包含以下两个条目,将 static 目录挂载到 assets 目录。

hugo。
     
module:
  mounts:
  - source: assets
    target: assets
  - source: static
    target: assets
[module]
  [[module.mounts]]
    source = 'assets'
    target = 'assets'
  [[module.mounts]]
    source = 'static'
    target = 'assets'
{
   "module": {
      "mounts": [
         {
            "source": "assets",
            "target": "assets"
         },
         {
            "source": "static",
            "target": "assets"
         }
      ]
   }
}

PageInner 详情

v0.125.0 中的新增功能

PageInner 的主要用例是解析相对于包含的 Page 的链接和 页面资源。例如,创建一个 “include” 短代码,从多个内容文件组成一个页面,同时为脚注和目录保留全局上下文。

layouts/shortcodes/include.html
{{ with .Get 0 }}
  {{ with $.Page.GetPage . }}
    {{- .RenderShortcodes }}
  {{ else }}
    {{ errorf "The %q shortcode was unable to find %q. See %s" $.Name . $.Position }}
  {{ end }}
{{ else }}
  {{ errorf "The %q shortcode requires a positional parameter indicating the logical path of the file to include. See %s" .Name .Position }}
{{ end }}

然后在您的 Markdown 中调用此短代码

content/posts/p1.md
{{% include "/posts/p2" %}}

在渲染 /posts/p2 时触发的任何渲染钩子都将获得

  • 调用 Page 时获得 /posts/p1
  • 调用 PageInner 时获得 /posts/p2

如果 PageInner 不相关,则会回退到 Page 的值,并且始终返回一个值。

PageInner 方法仅与调用 RenderShortcodes 方法的短代码相关,您必须使用 {{%..%}} 表示法调用短代码。

作为一个实际示例,Hugo 的嵌入式链接和图像渲染钩子使用 PageInner 方法来解析 Markdown 链接和图像目标。请参阅每个的源代码

  • 嵌入式链接渲染钩子
  • 嵌入式图像渲染钩子

另请参阅

  • 图像
  • 标题
  • 块引用
  • 代码块
  • 表格

本页内容

  • Markdown
  • 上下文
  • 示例
  • 默认
  • PageInner 详情
最后更新时间: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
  • 问题排查
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护