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

代码块渲染钩子

创建一个代码块渲染钩子来覆盖 Markdown 代码块到 HTML 的渲染。

Markdown

此 Markdown 示例包含一个代码块:

content/example.md
```bash {class="my-class" id="my-codeblock" lineNos=inline tabWidth=2}
declare a=1
echo "$a"
exit
```

一个代码块由以下部分组成:

  • 一个起始代码围栏 代码围栏
  • 一个可选的信息字符串 信息字符串
  • 一个代码示例
  • 一个结束代码围栏

在之前的示例中,信息字符串包含:

  • 代码示例的语言(第一个单词)
  • 一个可选的空格分隔或逗号分隔的属性列表(括号内的所有内容)

信息字符串中的属性可以是通用属性或突出显示选项。

在上面的示例中, 通用属性 是 class 和 id 。在代码块渲染钩子内没有特殊处理的情况下,Hugo 会将每个通用属性添加到围绕渲染代码块的 HTML 元素中。与它的内容安全模型一致,Hugo 会移除 HTML 事件属性,例如 onclick 和 onmouseover 。通用属性通常是全局 HTML 属性,但您也可以包含自定义属性。

在上面的示例中, 突出显示选项 是 lineNos 和 tabWidth 。Hugo 使用 Chroma 语法高亮器来渲染代码示例。您可以通过指定一个或多个 突出显示选项 来控制渲染代码的外观。

虽然 style 是一个全局 HTML 属性,但在信息字符串中使用时,它是一个突出显示选项。

上下文

代码块渲染钩子模板接收以下 上下文:

属性

(map) 信息字符串中的通用属性。

内部内容

(string) 起始和结束代码围栏之间的内容,不包括信息字符串。

选项

(map) 信息字符串中的突出显示选项。

序号

(int) 页面上代码块的基于零的序号。

页面

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

页面内部内容
New in v0.125.0

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

位置

(text.Position) 代码块在页面内容中的位置。

类型

(string) 信息字符串的第一个单词,通常是代码语言。

示例

在其默认配置中,Hugo 通过将代码示例传递给 Chroma 语法高亮器并包装结果来渲染代码块。要创建一个执行相同操作的渲染钩子:

layouts/_default/_markup/render-codeblock.html
{{ $result := transform.HighlightCodeBlock . }}
{{ $result.Wrapped }}

虽然您可以使用一个带有条件逻辑的模板来控制每个语言的行为,但您也可以创建特定于语言的模板。

layouts/
└── _default/
    └── _markup/
        ├── render-codeblock-mermaid.html
        ├── render-codeblock-python.html
        └── render-codeblock.html

例如,要创建一个代码块渲染钩子来渲染 Mermaid 图表:

layouts/_default/_markup/render-codeblock-mermaid.html
<pre class="mermaid">
  {{- .Inner | htmlEscape | safeHTML }}
</pre>
{{ .Page.Store.Set "hasMermaid" true }}

然后将此代码段包含在您的基础模板底部:

layouts/_default/baseof.html
{{ if .Store.Get "hasMermaid" }}
  <script type="module">
    import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.esm.min.mjs';
    mermaid.initialize({ startOnLoad: true });
  </script>
{{ end }}

查看 图表 页面以了解详情。

嵌入式

Hugo 包含一个 嵌入式代码块渲染钩子 来渲染 GoAT 图表 。

PageInner 详情

New in 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 不相关,则 PageInner 回退到 Page 的值,并始终返回值。

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

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

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

See also

  • Passthrough
  • 块引用
  • Images
  • 表格
  • 标题

On this page

  • Markdown
  • 上下文
  • 示例
  • 嵌入式
  • PageInner 详情
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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护