The Heading Render Hook Ignores Custom Classes

[boevski]

Environment

• Version of Docsy you are using: 0.11.0
• How are you using Docsy? As a:
  • Hugo module
  • NPM module
  • Git submodule
  • Other:
• Version of Hugo you are using (output of hugo version): 0.139.3+extended+withdeploy
• OS:
  • Linux
  • macOS
  • Windows
  • Other:

Problem

The render hook used by Docsy to add IDs to headings and to auto-link them ignores any custom classes that can be added using Markdown Attributes, breaking a core Hugo feature this way. In contrast, it adds custom IDs just fine.

The render hook was seemingly introduced with this PR.

The bug can be fixed as follows:

• Current layouts/_default/_markup/td-render-heading.html code:

<h{{ .Level }} id="{{- .Anchor | safeURL -}}">
  {{- .Text | safeHTML -}}
  {{ template "_default/_markup/_td-heading-self-link.html" . -}}
</h{{ .Level }}>

{{- define "_default/_markup/_td-heading-self-link.html" -}}
<a class="td-heading-self-link" href="#{{ .Anchor | safeURL }}" aria-label="Heading self-link"></a>
{{- end -}}

• Improved code:

<h{{ .Level }} id="{{- .Anchor | safeURL -}}" {{- with .Attributes.class }} class="{{ . }}" {{- end }}>
  {{- .Text | safeHTML -}}
  {{ template "_default/_markup/_td-heading-self-link.html" . -}}
</h{{ .Level }}>

{{- define "_default/_markup/_td-heading-self-link.html" -}}
<a class="td-heading-self-link" href="#{{ .Anchor | safeURL }}" aria-label="Heading self-link"></a>
{{- end -}}

[chalin]

Thanks @boevski, see:

• Render-heading: process class attributes #2165