hugo/docs/content/en/hugo-pipes/introduction.md

title	linkTitle	description	date	publishdate	lastmod	categories	keywords	menu	weight	sections_weight	draft	toc	aliases
Hugo Pipes Introduction	Hugo Pipes	Hugo Pipes is Hugo's asset processing set of functions.	2018-07-14	2018-07-14	2018-07-14	asset management		docs parent weight pipes 20	01	01	false	true	/assets/

Get Resource with resources.Get

In order to process an asset with Hugo Pipes, it must be retrieved as a Resource using resources.Get. The first argument can be either a local the path to file relative to the asset directory/directories or a remote URL.

{{ $local := resources.Get "sass/main.scss" }}
{{ $remote := resources.Get "https://www.example.com/styles.scss" }}

resources.Get will always return nil if the resource could not be found.

Error Handling

{{< new-in "0.90.1" >}}

The return value from resources.Get includes an .Err method that will return an error if the call failed. If you want to just log any error as a WARNING you can use a construct similar to the one below.

{{ with resources.Get "https://gohugo.io/images/gohugoio-card-1.png" }}
  {{ with .Err }}
    {{ warnf "%s" . }}
  {{ else }}
    <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
  {{ end }}
{{ end }}

Note that if you do not handle .Err yourself, Hugo will fail the build the first time you start using the Resource object.

Remote Options

When fetching a remote Resource, resources.Get takes an optional options map as the last argument, e.g.:

{{ $resource := resources.Get "https://example.org/api" (dict "headers" (dict "Authorization" "Bearer abcd"))  }}

If you need multiple values for the same header key, use a slice:

{{ $resource := resources.Get "https://example.org/api"  (dict "headers" (dict "X-List" (slice "a" "b" "c")))  }}

You can also change the request method and set the request body:

{{ $postResponse := resources.Get "https://example.org/api"  (dict 
    "method" "post"
    "body" `{"complete": true}` 
    "headers" (dict 
        "Content-Type" "application/json"
    )
)}}

Caching of Remote Resources

Remote resources fetched with resources.Get will be cached on disk. See Configure File Caches for details.

Asset directory

Asset files must be stored in the asset directory. This is /assets by default, but can be configured via the configuration file's assetDir key.

Asset Publishing

Assets will only be published (to /public) if .Permalink or .RelPermalink is used. You can use .Content to inline the asset.

Go Pipes

For improved readability, the Hugo Pipes examples of this documentation will be written using Go Pipes:

{{ $style := resources.Get "sass/main.scss" | resources.ToCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $style.Permalink }}">

Method aliases

Each Hugo Pipes resources transformation method uses a camelCased alias (toCSS for resources.ToCSS). Non-transformation methods deprived of such aliases are resources.Get, resources.FromString, resources.ExecuteAsTemplate and resources.Concat.

The example above can therefore also be written as follows:

{{ $style := resources.Get "sass/main.scss" | toCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $style.Permalink }}">

Caching

Hugo Pipes invocations are cached based on the entire pipe chain.

An example of a pipe chain is:

{{ $mainJs := resources.Get "js/main.js" | js.Build "main.js" | minify | fingerprint }}

The pipe chain is only invoked the first time it is encountered in a site build, and results are otherwise loaded from cache. As such, Hugo Pipes can be used in templates which are executed thousands or millions of times without negatively impacting the build performance.