Skip to content

Commit

Permalink
Disambiguate global and page resources
Browse files Browse the repository at this point in the history
There are 2 different kind of resource, one that is attached
to the page, matching all non-rendered files, and the global
one matching all files in `/assets`. Although they have similar
behaviour, the way to access both of them are slightly different.

Explicitly express differences between both and clarify when a page
is attached resources and when not.
  • Loading branch information
tjamet authored and bep committed May 9, 2020
1 parent 5e233dc commit 95bd797
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
11 changes: 10 additions & 1 deletion content/en/content-management/image-processing/index.md
Expand Up @@ -18,14 +18,23 @@ menu:

The `image` is a [Page Resource]({{< relref "/content-management/page-resources" >}}), and the processing methods listed below do not work on images inside your `/static` folder.

To get all images in a [Page Bundle]({{< relref "/content-management/organization#page-bundles" >}}):
To print all images paths in a [Page Bundle]({{< relref "/content-management/organization#page-bundles" >}}):

```go-html-template
{{ with .Resources.ByType "image" }}
{{ range . }}
{{ .RelPermalink }}
{{ end }}
{{ end }}
```

## The Image Resource

The `image` resource can also be retrieved from a [global resource]({{< relref "/hugo-pipes/introduction#from-file-to-resource" >}})

{{- $image := resources.Get "images/logo.jpg" -}}

## Image Processing Methods

The `image` resource implements the methods `Resize`, `Fit` and `Fill`, each returning the transformed image using the specified dimensions and processing options. The `image` resource also, since Hugo 0.58, implements the method `Exif` and `Filter`.
Expand Down
8 changes: 8 additions & 0 deletions content/en/content-management/page-bundles.md
Expand Up @@ -73,6 +73,14 @@ my-post
: This leaf bundle has the `index.md`, two other content
Markdown files and two image files.

image1
: This image is a page resource of `my-post`
and only available in `my-post/index.md` resources.

image2
: This image is a page resource of `my-post`
and only available in `my-post/index.md` resources.

my-other-post
: This leaf bundle has only the `index.md`.

Expand Down
4 changes: 4 additions & 0 deletions content/en/content-management/page-resources.md
Expand Up @@ -14,6 +14,10 @@ menu:
weight: 31
---

Page resources are available for [page bundles]({{< relref "/content-management/page-bundles" >}}) only,
i.e. a directory with either a `index.md`, or `_index.md` file at its root. Resources are only attached to
the lowest page they are bundled with, and simple which names does not contain `index.md` are not attached any resource.

## Properties

ResourceType
Expand Down

0 comments on commit 95bd797

Please sign in to comment.