标题渲染钩子

上下文

标题渲染钩子模板接收以下上下文：

锚点

(string) 标题元素的 id 属性。

属性

(map) Markdown 属性 ，如果您按如下方式配置站点，则可用：

markup:
  goldmark:
    parser:
      attribute:
        title: true

[markup]
  [markup.goldmark]
    [markup.goldmark.parser]
      [markup.goldmark.parser.attribute]
        title = true

{
   "markup": {
      "goldmark": {
         "parser": {
            "attribute": {
               "title": true
            }
         }
      }
   }
}

级别

(int) 标题级别，1 到 6。

页面

(page) 当前页面的引用。

页面内部

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

纯文本

(string) 标题文本作为纯文本。

文本

(template.HTML) 标题文本。

示例

在其默认配置中，Hugo 根据 CommonMark 规范 渲染 Markdown 标题，并添加自动 id 属性。要创建一个执行相同操作的渲染钩子：

<h{{ .Level }} id="{{ .Anchor }}">
  {{- .Text -}}
</h{{ .Level }}>

要向每个标题的右侧添加锚点链接：

<h{{ .Level }} id="{{ .Anchor }}">
  {{ .Text }}
  <a href="#{{ .Anchor }}">#</a>
</h{{ .Level }}>

PageInner 详情

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

{{ 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中调用短代码：

{{% include "/posts/p2" %}}

在渲染 /posts/p2 期间触发的任何渲染钩子将获得：

• 调用 Page 时为 /posts/p1
• 调用 PageInner 时为 /posts/p2

如果与 PageInner 不相关，则 PageInner 回退到 Page 的值，并始终返回值。

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

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