1
0
Fork 0
hugo/docs/content/en/methods/page/Resources.md

2.8 KiB

title description categories keywords action toc
Resources Returns a collection of page resources.
related returnType signatures
functions/resources/ByType
functions/resources/Get
functions/resources/GetMatch
functions/resources/GetRemote
functions/resources/Match
resource.Resources
PAGE.Resources
true

The Resources method on a Page object returns a collection of page resources. A page resource is a file within a page bundle.

To work with global or remote resources, see the resources functions.

Methods

ByType

(resource.Resources) Returns a collection of page resources of the given media type, or nil if none found. The media type is typically one of image, text, audio, video, or application.

{{ range .Resources.ByType "image" }}
  <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}

When working with global resources instead of page resources, use the resources.ByType function.

Get

(resource.Resource) Returns a page resource from the given path, or nil if none found.

{{ with .Resources.Get "images/a.jpg" }}
  <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}

When working with global resources instead of page resources, use the resources.Get function.

GetMatch

(resource.Resource) Returns the first page resource from paths matching the given glob pattern, or nil if none found.

{{ with .Resources.GetMatch "images/*.jpg" }}
  <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}

When working with global resources instead of page resources, use the resources.GetMatch function.

Match

(resource.Resources) Returns a collection of page resources from paths matching the given glob pattern, or nil if none found.

{{ range .Resources.Match "images/*.jpg" }}
  <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}

When working with global resources instead of page resources, use the resources.Match function.

Pattern matching

With the GetMatch and Match methods, Hugo determines a match using a case-insensitive glob pattern.

{{% include "functions/_common/glob-patterns.md" %}}