https://v0-122-0--gohugoio.netlify.app/methods/resource/Recent content in Resource methods on HugoHugo -- gohugo.ioenhttps://v0-122-0--gohugoio.netlify.app/methods/resource/colors/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/colors/New in v0.104.0 {{ with resources.Get "images/a.jpg" }} {{ .Colors }} → [#bebebd #514947 #768a9a #647789 #90725e #a48974] {{ end }} This method is fast, but if you also scale down your images, it would be good for performance to extract the colors from the scaled image. Use this method with global, page, or remote resources.https://v0-122-0--gohugoio.netlify.app/methods/resource/content/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/content/The Content method on a Resource object returns template.HTML when the resource type is page, otherwise it returns a string. assets/quotations/kipling.txt He travels the fastest who travels alone. To get the content: {{ with resources.Get "quotations/kipling.txt" }} {{ .Content }} → He travels the fastest who travels alone. {{ end }} To get the size in bytes: {{ with resources.Get "quotations/kipling.txt" }} {{ .Content | len }} → 42 {{ end }} To create an inline image:https://v0-122-0--gohugoio.netlify.app/methods/resource/crop/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/crop/Crop an image to match the given dimensions without resizing. You must provide both width and height. {{ with resources.Get "images/original.jpg" }} {{ with .Crop "200x200" }} <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt=""> {{ end }} {{ end }} Use this method with global, page, or remote resources. Process specification The process specification is a space-delimited, case-insensitive list of one or more of the following in any sequence:https://v0-122-0--gohugoio.netlify.app/methods/resource/data/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/data/The Data method on a resource returned by the resources.GetRemote function returns information from the HTTP response. {{ $url := "https://example.org/images/a.jpg" }} {{ with resources.GetRemote $url }} {{ with .Err }} {{ errorf "%s" . }} {{ else }} {{ with .Data }} {{ .ContentLength }} → 42764 {{ .ContentType }} → image/jpeg {{ .Status }} → 200 OK {{ .StatusCode }} → 200 {{ .TransferEncoding }} → [] {{ end }} {{ end }} {{ else }} {{ errorf "Unable to get remote resource %q" $url }} {{ end }} ContentLength (int) The content length in bytes.https://v0-122-0--gohugoio.netlify.app/methods/resource/err/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/err/The Err method on a resource returned by the resources.GetRemote function returns an error message if the HTTP request fails, else nil. If you do not handle the error yourself, Hugo will fail the build. In this example we send an HTTP request to a nonexistent domain: {{ $url := "https://broken-example.org/images/a.jpg" }} {{ with resources.GetRemote $url }} {{ with .Err }} {{ errorf "%s" . }} {{ else }} <img src="{{ .https://v0-122-0--gohugoio.netlify.app/methods/resource/exif/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/exif/Applicable to JPEG and TIFF images, the Exif method on an image Resource object returns an EXIF object containing image metadata. Methods Date (time.Time) Returns the image creation date/time. Format with the time.Formatfunction. Lat (float64) Returns the GPS latitude in degrees. Long (float64) Returns the GPS longitude in degrees. Tags (exif.Tags) Returns a collection of the available EXIF tags for this image. You may include or exclude specific tags from this collection in the site configuration.https://v0-122-0--gohugoio.netlify.app/methods/resource/fill/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/fill/Crop and resize an image to match the given dimensions. You must provide both width and height. {{ with resources.Get "images/original.jpg" }} {{ with .Fill "200x200" }} <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt=""> {{ end }} {{ end }} Use this method with global, page, or remote resources. Process specification The process specification is a space-delimited, case-insensitive list of one or more of the following in any sequence:https://v0-122-0--gohugoio.netlify.app/methods/resource/filter/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/filter/Apply one or more image filters to the given image. To apply a single filter: {{ with resources.Get "images/original.jpg" }} {{ with .Filter images.Grayscale }} <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt=""> {{ end }} {{ end }} To apply two or more filters, executing from left to right: {{ $filters := slice images.Grayscale (images.GaussianBlur 8) }} {{ with resources.Get "images/original.jpg" }} {{ with .Filter $filters }} <img src="{{ .https://v0-122-0--gohugoio.netlify.app/methods/resource/fit/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/fit/Downscale an image to fit the given dimensions while maintaining aspect ratio. You must provide both width and height. {{ with resources.Get "images/original.jpg" }} {{ with .Fit "200x200" }} <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt=""> {{ end }} {{ end }} Use this method with global, page, or remote resources. Process specification The process specification is a space-delimited, case-insensitive list of one or more of the following in any sequence:https://v0-122-0--gohugoio.netlify.app/methods/resource/height/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/height/{{ with resources.Get "images/a.jpg" }} {{ .Height }} → 400 {{ end }} Use the Width and Height methods together when rendering an img element: {{ with resources.Get "images/a.jpg" }} <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}"> {{ end }} Use this method with global, page, or remote resources.https://v0-122-0--gohugoio.netlify.app/methods/resource/key/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/key/By way of example, consider this site configuration: hugo. yaml   toml   json   baseURL: https://example.org/docs/ baseURL = 'https://example.org/docs/' { "baseURL": "https://example.org/docs/" } And this template: {{ with resources.Get "images/a.jpg" }} {{ with resources.Copy "foo/bar/b.jpg" . }} {{ .Key }} → foo/bar/b.jpg {{ .Name }} → images/a.jpg {{ .Title }} → images/a.jpg {{ .RelPermalink }} → /docs/foo/bar/b.jpg {{ end }} {{ end }} We used the resources.Copy function to change the publishing path.https://v0-122-0--gohugoio.netlify.app/methods/resource/mediatype/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/mediatype/The MediaType method on a Resource object returns an object with additional methods. Methods Type (string) The resource’s media type. {{ with resources.Get "images/a.jpg" }} {{ .MediaType.Type }} → image/jpeg {{ end }} MainType (string) The main type of the resource’s media type. {{ with resources.Get "images/a.jpg" }} {{ .MediaType.MainType }} → image {{ end }} SubType (string) The subtype of the resource’s media type. This may or may not correspond to the file suffix.https://v0-122-0--gohugoio.netlify.app/methods/resource/name/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/name/The value returned by the Name method on a Resource object depends on the resource type. Global resource With a global resource, the Name method returns the path to the resource, relative to the assets directory. assets/ └── images/ └── a.jpg {{ with resources.Get "images/a.jpg" }} {{ .Name }} → images/a.jpg {{ end }} Page resource With a page resource, the Name method returns the path to the resource, relative to the page bundle.https://v0-122-0--gohugoio.netlify.app/methods/resource/params/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/params/Use the Params method with page resources. It is not applicable to either global or remote resources. With this content structure: content/ ├── posts/ │ ├── cats/ │ │ ├── images/ │ │ │ └── a.jpg │ │ └── index.md │ └── _index.md └── _index.md And this front matter: content/posts/cats.md yaml   toml   json   --- resources: - params: alt: Photograph of black cat temperament: vicious src: images/a.jpg title: Felix the cat title: Cats --- +++ title = 'Cats' [[resources]] src = 'images/a.https://v0-122-0--gohugoio.netlify.app/methods/resource/permalink/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/permalink/The Permalink method on a Resource object writes the resource to the publish directory, typically public, and returns its permalink. {{ with resources.Get "images/a.jpg" }} {{ .Permalink }} → https://example.org/images/a.jpg {{ end }} Use this method with global, page, or remote resources.https://v0-122-0--gohugoio.netlify.app/methods/resource/process/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/process/Process an image with the given specification. The specification can contain an optional action, one of crop, fill, fit, or resize. This means that you can use this method instead of Crop, Fill, Fit, or Resize. {{ with resources.Get "images/original.jpg" }} {{ with .Process "crop 200x200" }} <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt=""> {{ end }} {{ end }} You can also use this method to apply simple transformations such as rotation and conversion:https://v0-122-0--gohugoio.netlify.app/methods/resource/publish/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/publish/The Publish method on a Resource object writes the resource to the publish directory, typically public. {{ with resources.Get "images/a.jpg" }} {{ .Publish }} {{ end }} The Permalink and RelPermalink methods also publish a resource. Publish is a convenience method for publishing without a return value. For example, this: {{ $resource.Publish }} Instead of this: {{ $noop := $resource.Permalink }} Use this method with global, page, or remote resources.https://v0-122-0--gohugoio.netlify.app/methods/resource/relpermalink/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/relpermalink/The Permalink method on a Resource object writes the resource to the publish directory, typically public, and returns its relative permalink. {{ with resources.Get "images/a.jpg" }} {{ .RelPermalink }} → /images/a.jpg {{ end }} Use this method with global, page, or remote resources.https://v0-122-0--gohugoio.netlify.app/methods/resource/resize/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/resize/Resize an image to the given width and/or height. If you specify both width and height, the resulting image will be disproportionally scaled unless the original image has the same aspect ratio. {{ with resources.Get "images/original.jpg" }} {{ with .Resize "300x" }} <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt=""> {{ end }} {{ end }} Use this method with global, page, or remote resources. Process specification The process specification is a space-delimited, case-insensitive list of one or more of the following in any sequence:https://v0-122-0--gohugoio.netlify.app/methods/resource/resourcetype/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/resourcetype/Common resource types include audio, image, text, and video. {{ with resources.Get "image/a.jpg" }} {{ .ResourceType }} → image {{ .MediaType.MainType }} → image {{ end }} When working with content files, the resource type is page. content/ ├── lessons/ │ ├── lesson-1/ │ │ ├── _objectives.md <-- resource type = page │ │ ├── _topics.md <-- resource type = page │ │ ├── _example.jpg <-- resource type = image │ │ └── index.https://v0-122-0--gohugoio.netlify.app/methods/resource/title/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/title/The value returned by the Title method on a Resource object depends on the resource type. Global resource With a global resource, the Title method returns the path to the resource, relative to the assets directory. assets/ └── images/ └── a.jpg {{ with resources.Get "images/a.jpg" }} {{ .Title }} → images/a.jpg {{ end }} Page resource With a page resource, the Title method returns the path to the resource, relative to the page bundle.https://v0-122-0--gohugoio.netlify.app/methods/resource/width/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/resource/width/{{ with resources.Get "images/a.jpg" }} {{ .Width }} → 600 {{ end }} Use the Width and Height methods together when rendering an img element: {{ with resources.Get "images/a.jpg" }} <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}"> {{ end }} Use this method with global, page, or remote resources.