81a7b63900
4429eeeea Update image render hooks examples to conform with Commonmark 5391dddea Add class attribute to heading render hook examples git-subtree-dir: docs git-subtree-split: 4429eeeea84bfa4b9e636deaab5c9620ccf776a6
2 KiB
Executable file
| title | linkTitle | description | categories | keywords | menu | weight | toc | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Heading render hooks | Headings | Create a heading render hook to override the rendering of Markdown headings to HTML. |
|
|
50 | true |
Context
Heading render hook templates receive the following context:
Anchor
(string) The id attribute of the heading element.
Attributes
(map) The Markdown attributes, available if you configure your site as follows:
{{< code-toggle file=hugo >}} [markup.goldmark.parser.attribute] title = true {{< /code-toggle >}}
Level
(int) The heading level, 1 through 6.
Page
(page) A reference to the current page.
PageInner
{{< new-in 0.125.0 >}}
(page) A reference to a page nested via the RenderShortcodes method. See details.
PlainText
(string) The heading text as plain text.
Text
(template.HTML) The heading text.
Examples
In its default configuration, Hugo renders Markdown headings according to the CommonMark specification with the addition of automatic id attributes. To create a render hook that does the same thing:
{{< code file=layouts/_default/_markup/render-heading.html copy=true >}} <h{{ .Level }} id="{{ .Anchor }}" {{- with .Attributes.class }} class="{{ . }}" {{- end }}> {{- .Text -}} </h{{ .Level }}> {{< /code >}}
To add an anchor link to the right of each heading:
{{< code file=layouts/_default/_markup/render-heading.html copy=true >}} <h{{ .Level }} id="{{ .Anchor }}" {{- with .Attributes.class }} class="{{ . }}" {{- end }}> {{ .Text }} # </h{{ .Level }}> {{< /code >}}
{{% include "/render-hooks/_common/pageinner.md" %}}