Image render hooks

Markdown

A Markdown image has three components: the image description, the image destination, and optionally the image title.

![white kitten](/images/kitten.jpg "A kitten!")
  ------------  ------------------  ---------
  description      destination        title

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

Context

Image render hook templates receive the following context:

Attributes : (map) The Markdown attributes, available if you configure your site as follows:

{{< code-toggle file=hugo >}} [markup.goldmark.parser] wrapStandAloneImageWithinParagraph = false [markup.goldmark.parser.attribute] block = true {{< /code-toggle >}}

Destination : (string) The image destination.

IsBlock : (bool) Reports whether a standalone image is not wrapped within a paragraph element.

Ordinal : (int) The zero-based ordinal of the image on the page.

Page : (page) A reference to the current page.

PageInner : (page) A reference to a page nested via the RenderShortcodes method. See details.

PlainText : (string) The image description as plain text.

Text : (template.HTML) The image description.

Title : (string) The image 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 images according to the CommonMark specification. To create a render hook that does the same thing:

{{- /* chomp trailing newline */ -}}

To render standalone images within figure elements:

{{- if .IsBlock -}}
  <figure>
    
    {{- with .Title }}<figcaption>{{ . }}</figcaption>{{ end -}}
  </figure>
{{- else -}}
  
{{- end -}}

Note that the above requires the following project configuration:

{{< code-toggle file=hugo >}} [markup.goldmark.parser] wrapStandAloneImageWithinParagraph = false {{< /code-toggle >}}

Embedded

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

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

When set to auto as shown above, Hugo automatically uses the embedded image render hook for multilingual single-host projects, specifically when the duplication of shared page resources feature is disabled. This is the default behavior for such projects. If custom image 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 image render hook, use it only as a fallback, or never use it. See details.

The embedded image render hook resolves internal Markdown destinations by looking for a matching page resource, 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 project configuration:

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

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

Note that the embedded image render hook does not perform image processing. Its sole purpose is to resolve Markdown image destinations.

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