hugoDocs/content/en/render-hooks/links.md

title	linkTitle	description	categories	keywords
Link render hooks	Links	Create a link render hook to override the rendering of Markdown links to HTML.

Markdown

A Markdown link has three components: the link text, the link destination, and optionally the link title.

[Post 1](/posts/post-1 "My first post")
 ------  -------------  -------------
  text    destination       title

These components are passed into the render hook context as shown below.

Context

Link render hook templates receive the following context:

Destination

(string) The link destination.

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 link description as plain text.

Text

(template.HTML) The link description.

Title

(string) The link title.

Examples

Note

With inline elements such as images and links, remove leading and trailing whitespace using the {{‑ ‑}} delimiter notation to prevent whitespace between adjacent inline elements and text.

In its default configuration, Hugo renders Markdown links according to the CommonMark specification. To create a render hook that does the same thing:

<a href="{{ .Destination | safeURL }}"
  {{- with .Title }} title="{{ . }}"{{ end -}}
>
  {{- with .Text }}{{ . }}{{ end -}}
</a>
{{- /* chomp trailing newline */ -}}

To include a rel attribute set to external for external links:

{{- $u := urls.Parse .Destination -}}
<a href="{{ .Destination | safeURL }}"
  {{- with .Title }} title="{{ . }}"{{ end -}}
  {{- if $u.IsAbs }} rel="external"{{ end -}}
>
  {{- with .Text }}{{ . }}{{ end -}}
</a>
{{- /* chomp trailing newline */ -}}

Embedded

{{< new-in 0.123.0 />}}

Hugo includes an embedded link render hook to resolve Markdown link destinations. You can adjust its behavior in your site configuration. This is the default setting:

{{< code-toggle file=hugo >}} [markup.goldmark.renderHooks.link] useEmbedded = 'auto' {{< /code-toggle >}}

When set to auto as shown above, Hugo automatically uses the embedded link render hook for multilingual single-host sites, specifically when the duplication of shared page resources feature is disabled. This is the default behavior for such sites. If custom link render hooks are defined by your project, modules, or themes, these will be used instead.

You can also configure Hugo to always use the embedded link render hook, use it only as a fallback, or never use it. See details.

The embedded link render hook resolves internal Markdown destinations by looking for a matching page, falling back to a matching page resource, then falling back to a matching global resource. Remote destinations are passed through, and the render hook will not throw an error or warning if unable to resolve a destination.

You must place global resources in the assets directory. If you have placed your resources in the static directory, and you are unable or unwilling to move them, you must mount the static directory to the assets directory by including both of these entries in your site configuration:

{{< code-toggle file=hugo >}} module.mounts source = 'assets' target = 'assets'

module.mounts source = 'static' target = 'assets' {{< /code-toggle >}}

{{% include "/_common/render-hooks/pageinner.md" %}}