Create default link and image render hooks

[jmooring]

With the implementation of #11453 and #11904 we no longer duplicate page resources per language¹. This is applicable to multilingual, single-host sites.

When resources are not duplicated per language (the default), link and image render hooks are required to properly resolve markdown destinations (links and image).

Per this discussion, the site config would be:

[markup.goldmark.renderhooks.image]
enable = true
multilingualOnly = true

[markup.goldmark.renderhooks.link]
enable = true
multilingualOnly = true

Candidate render hooks:

layouts/_default/_markup/render-image.html

{{- $u := urls.Parse .Destination -}}
{{- $src := $u.String -}}
{{- if not $u.IsAbs -}}
  {{- with or (.Page.Resources.Get $u.Path) (resources.Get $u.Path) -}}
    {{- $src = .RelPermalink -}}
  {{- end -}}
{{- end -}}
{{- $attributes := dict "alt" .Text "src" $src "title" .Title -}}
<img
  {{- range $k, $v := $attributes -}}
    {{- if $v -}}
      {{- printf " %s=%q" $k $v | safeHTMLAttr -}}
    {{- end -}}
  {{- end -}}
>
{{- /**/ -}}

layouts/_default/_markup/render-link.html

{{- $u := urls.Parse .Destination -}}
{{- $href := $u.String -}}
{{- if not $u.IsAbs -}}
  {{- with or
    ($.Page.GetPage $u.Path)
    ($.Page.GetPage (strings.TrimRight "/" $u.Path))
    ($.Page.Resources.Get $u.Path)
    (resources.Get $u.Path)
  -}}
    {{- $href = .RelPermalink -}}
    {{- with $u.RawQuery -}}
      {{- $href = printf "%s?%s" $href . -}}
    {{- end -}}
    {{- with $u.Fragment -}}
      {{- $href = printf "%s#%s" $href . -}}
    {{- end -}}
  {{- end -}}
{{- end -}}
{{- $attributes := dict "href" $href "title" .Title -}}
<a
  {{- range $k, $v := $attributes -}}
    {{- if $v -}}
      {{- printf " %s=%q" $k $v | safeHTMLAttr -}}
    {{- end -}}
  {{- end -}}
>{{ .Text | safeHTML }}</a>
{{- /**/ -}}

Test site:

git clone --single-branch -b hugo-github-issue-11933 https://github.com/jmooring/hugo-testing hugo-github-issue-11933
cd hugo-github-issue-11933
hugo server

Footnotes

1. This can be disabled by setting markup.goldmark.duplicateResourceFiles = true in site configuration. ↩

[bep]

Just to be clear, when I do

[markup.goldmark.renderhooks.link]
enable = false

That toggle is just for the "default templates" not the "user provided" ... or both?

[jmooring]

That toggle is just for...

Yeah, I get it. There's a couple of cases I didn't consider. Let me think about this for a bit.

[jmooring]

Here's my thought process on this...

1) With a multilingual single-host site where markup.goldmark.duplicateResourceFiles = false, do you always need link and image render hooks? Yes. So let's hardcode that bit, always enabling the default link and image render hooks under the following conditions:

• Site is multilingual, and
• Site is single-host, and
• markup.goldmark.duplicateResourceFiles = false

Note the default hooks will always be overridden by user-provided hooks if present (in the same way that any of the built-in templates are overridden, including the built-in GoAT hook).

2) Is there ever a time, with any type of site, that you would want the default render hooks to override user-provided hooks? No.

3) Do we need or want a flag to disable both default and user-provided hooks? No. We don't have a flag like that for heading or code block hooks.

So, what about?

[markup.goldmark.renderhooks.image]
enableDefault = false   <-- hardcoded to true per criteria above

[markup.goldmark.renderhooks.link]
enableDefault = false   <-- hardcoded to true per criteria above

We wouldn't need the multilingualOnly because it would be hardcoded (see item 1).

[bep]

Since detecting a false that's explicitly set is harder than the other way around, I suggest we do:

[markup.goldmark.renderhooks.image]
disableDefault = true   <-- hardcoded to false per criteria above.

[jmooring]

Sounds good to me.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.