diff options
Diffstat (limited to 'docs/content/en/hugo-pipes/introduction.md')
| -rwxr-xr-x | docs/content/en/hugo-pipes/introduction.md | 10 |
1 files changed, 2 insertions, 8 deletions
diff --git a/docs/content/en/hugo-pipes/introduction.md b/docs/content/en/hugo-pipes/introduction.md index a3c956885..c16572e48 100755 --- a/docs/content/en/hugo-pipes/introduction.md +++ b/docs/content/en/hugo-pipes/introduction.md @@ -4,7 +4,6 @@ linkTitle: Hugo Pipes description: Hugo Pipes is Hugo's asset processing set of functions. date: 2018-07-14 publishdate: 2018-07-14 -lastmod: 2018-07-14 categories: [asset management] keywords: [] menu: @@ -31,10 +30,8 @@ Note that you can mount any directory into Hugo's virtual `assets` folder using | `resources.GetMatch` | `GetMatch` finds the first Resource matching the given pattern, or nil if none found. See Match for a more complete explanation about the rules used. | | `resources.Match` | `Match` gets all resources matching the given base path prefix, e.g "*.png" will match all png files. The "*" does not match path delimiters (/), so if you organize your resources in sub-folders, you need to be explicit about it, e.g.: "images/*.png". To match any PNG image anywhere in the bundle you can do "\*\*.png", and to match all PNG images below the images folder, use "images/\*\*.jpg". The matching is case insensitive. Match matches by using the files name with path relative to the file system root with Unix style slashes (/) and no leading slash, e.g. "images/logo.png". See https://github.com/gobwas/glob for the full rules set.| - See the [GoDoc Page](https://pkg.go.dev/github.com/gohugoio/hugo@v0.93.1/tpl/resources) for the `resources` package for an up to date overview of all template functions in this namespace. - ## Get Resource with resources.Get and resources.GetRemote In order to process an asset with Hugo Pipes, it must be retrieved as a `Resource` using `resources.Get` or `resources.GetRemote`. @@ -68,7 +65,6 @@ With `resources.GetRemote`, the first argument is a remote URL: By default, Hugo calculates a cache key based on the `URL` and the `options` (e.g. headers) given. - {{< new-in "0.97.0" >}} You can override this by setting a `key` in the options map. This can be used to get more fine grained control over how often a remote resource is fetched, e.g.: @@ -79,8 +75,6 @@ By default, Hugo calculates a cache key based on the `URL` and the `options` (e. ### Error Handling -{{< new-in "0.91.0" >}} - The return value from `resources.GetRemote` 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. ```go-html-template @@ -131,7 +125,7 @@ Asset files must be stored in the asset directory. This is `/assets` by default, ### Asset Publishing -Hugo publishes assets to the to the `publishDir` (typically `public`) when you invoke `.Permalink`, `.RelPermalink`, or `.Publish`. You can use `.Content` to inline the asset. +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 @@ -156,7 +150,7 @@ The example above can therefore also be written as follows: ## Caching -Hugo Pipes invocations are cached based on the entire _pipe chain_. +Hugo Pipes invocations are cached based on the entire *pipe chain*. An example of a pipe chain is: |