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

title	linkTitle	description	categories	keywords	menu	weight	toc	aliases
Hugo Pipes	Introduction	Hugo Pipes is Hugo's asset processing set of functions.	asset management		docs parent weight hugo-pipes 20	20	true	/assets/

Find resources in assets

This is about global and remote resources.

global resource

A file within the assets directory, or within any directory mounted to the assets directory.

remote resource

A file on a remote server, accessible via HTTP or HTTPS.

For .Page scoped resources, see the page resources section.

Get a resource

In order to process an asset with Hugo Pipes, it must be retrieved as a resource.

For global resources, use:

• resources.ByType
• resources.Get
• resources.GetMatch
• resources.Match

For remote resources, use:

• resources.GetRemote

See the GoDoc Page for the resources package for an up to date overview of all template functions in this namespace.

Copy a resource

See the resources.Copy function.

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

Hugo publishes assets to the publishDir (typically public) when you invoke .Permalink, .RelPermalink, or .Publish. 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 }}">

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.