2015-09-23 03:18:20 -04:00
---
2014-05-29 18:42:05 -04:00
aliases:
- /layout/functions/
2016-01-06 17:45:19 -05:00
lastmod: 2015-09-20
2014-05-29 18:42:05 -04:00
date: 2013-07-01
linktitle: Functions
2015-05-11 12:39:40 -04:00
toc: true
2014-04-23 03:00:11 -04:00
menu:
main:
2014-05-29 18:42:05 -04:00
parent: layout
next: /templates/variables
prev: /templates/go-templates
title: Hugo Template Functions
weight: 20
2014-02-18 18:35:27 -05:00
---
2014-08-31 07:08:36 -04:00
Hugo uses the excellent Go html/template library for its template engine.
2014-02-18 18:35:27 -05:00
It is an extremely lightweight engine that provides a very small amount of
2015-01-17 02:45:53 -05:00
logic. In our experience, it is just the right amount of logic to be able
2014-02-18 18:35:27 -05:00
to create a good static website.
Go templates are lightweight but extensible. Hugo has added the following
functions to the basic template logic.
2014-09-10 12:42:58 -04:00
(Go itself supplies built-in functions, including comparison operators
and other basic tools; these are listed in the
[Go template documentation ](http://golang.org/pkg/text/template/#hdr-Functions ).)
2014-02-18 18:35:27 -05:00
## General
2016-03-09 15:40:00 -05:00
### default
Checks whether a given value is set and returns a default value if it is not.
2016-03-16 13:45:50 -04:00
"Set" in this context means non-zero for numeric types and times;
non-zero length for strings, arrays, slices, and maps;
any boolean or struct value; or non-nil for any other types.
2016-03-09 15:40:00 -05:00
e.g.
2016-03-09 15:56:54 -05:00
{{ index .Params "font" | default "Roboto" }} → default is "Roboto"
2016-03-09 17:27:56 -05:00
{{ default "Roboto" (index .Params "font") }} → default is "Roboto"
2016-03-09 15:40:00 -05:00
2015-04-04 05:12:11 -04:00
### delimit
Loops through any array, slice or map and returns a string of all the values separated by the delimiter. There is an optional third parameter that lets you choose a different delimiter to go between the last two values.
Maps will be sorted by the keys, and only a slice of the values will be returned, keeping a consistent output order.
Works on [lists ](/templates/list/ ), [taxonomies ](/taxonomies/displaying/ ), [terms ](/templates/terms/ ), [groups ](/templates/list/ )
e.g.
// Front matter
+++
tags: [ "tag1", "tag2", "tag3" ]
+++
// Used anywhere in a template
Tags: {{ delimit .Params.tags ", " }}
// Outputs Tags: tag1, tag2, tag3
// Example with the optional "last" parameter
Tags: {{ delimit .Params.tags ", " " and " }}
// Outputs Tags: tag1, tag2 and tag3
2014-02-18 18:35:27 -05:00
2015-10-02 11:30:21 -04:00
### dict
2015-12-23 11:31:07 -05:00
Creates a dictionary `(map[string, interface{})` , expects parameters added in value:object fasion.
Invalid combinations like keys that are not strings or uneven number of parameters, will result in an exception thrown.
2015-10-02 11:30:21 -04:00
Useful for passing maps to partials when adding to a template.
e.g. Pass into "foo.html" a map with the keys "important, content"
{{$important := .Site.Params.SomethingImportant }}
{{range .Site.Params.Bar}}
{{partial "foo" (dict "content" . "important" $important)}}
{{end}}
"foo.html"
Important {{.important}}
{{.content}}
2016-03-16 08:04:33 -04:00
or create a map on the fly to pass into
2015-10-02 11:30:21 -04:00
{{partial "foo" (dict "important" "Smiles" "content" "You should do more")}}
2016-03-21 19:28:42 -04:00
2015-10-02 11:30:21 -04:00
2014-02-18 18:35:27 -05:00
2016-02-27 10:51:07 -05:00
### slice
`slice` allows you to create an array (`[]interface{}`) of all arguments that you pass to this function.
One use case is the concatenation of elements in combination with `delimit` :
```html
{{ delimit (slice "foo" "bar" "buzz") ", " }}
<!-- returns the string "foo, bar, buzz" -->
```
2014-02-18 18:35:27 -05:00
### echoParam
2015-08-04 14:00:08 -04:00
Prints a parameter if it is set.
2014-02-18 18:35:27 -05:00
2015-08-04 14:00:08 -04:00
e.g. `{{ echoParam .Params "project_url" }}`
2014-02-18 18:35:27 -05:00
2015-04-04 05:12:11 -04:00
2014-09-09 09:26:51 -04:00
### eq
2015-08-04 14:00:08 -04:00
Returns true if the parameters are equal.
2014-09-09 09:26:51 -04:00
e.g.
2014-12-04 11:26:12 -05:00
{{ if eq .Section "blog" }}current{{ end }}
2014-09-09 09:26:51 -04:00
2015-04-04 05:12:11 -04:00
2014-02-18 18:35:27 -05:00
### first
2015-08-04 14:00:08 -04:00
Slices an array to only the first _N_ elements.
2014-02-18 18:35:27 -05:00
2014-08-30 00:57:38 -04:00
Works on [lists ](/templates/list/ ), [taxonomies ](/taxonomies/displaying/ ), [terms ](/templates/terms/ ), [groups ](/templates/list/ )
2014-09-03 00:12:26 -04:00
e.g.
2014-12-04 11:26:12 -05:00
2014-02-18 18:35:27 -05:00
{{ range first 10 .Data.Pages }}
2014-12-04 11:26:12 -05:00
{{ .Render "summary" }}
2014-02-18 18:35:27 -05:00
{{ end }}
2016-03-06 08:58:15 -05:00
### jsonify
Encodes a given object to JSON.
e.g.
{{ dict "title" .Title "content" .Plain | jsonify }}
2015-06-10 18:12:27 -04:00
### last
2015-08-04 14:00:08 -04:00
Slices an array to only the last _N_ elements.
2015-06-10 18:12:27 -04:00
Works on [lists ](/templates/list/ ), [taxonomies ](/taxonomies/displaying/ ), [terms ](/templates/terms/ ), [groups ](/templates/list/ )
e.g.
{{ range last 10 .Data.Pages }}
{{ .Render "summary" }}
{{ end }}
2015-06-10 17:53:39 -04:00
### after
2015-08-04 14:00:08 -04:00
Slices an array to only the items after the < em > N< / em > th item. Use this in combination
with `first` to use both halves of an array split at item _N_ .
2015-06-10 17:53:39 -04:00
2015-06-10 18:12:27 -04:00
Works on [lists ](/templates/list/ ), [taxonomies ](/taxonomies/displaying/ ), [terms ](/templates/terms/ ), [groups ](/templates/list/ )
2015-06-10 17:53:39 -04:00
e.g.
{{ range after 10 .Data.Pages }}
{{ .Render "title" }}
{{ end }}
2014-08-30 00:57:38 -04:00
2015-04-04 21:07:25 -04:00
### getenv
Returns the value of an environment variable.
Takes a string containing the name of the variable as input. Returns
an empty string if the variable is not set, otherwise returns the
value of the variable. Note that in Unix-like environments, the
variable must also be exported in order to be seen by `hugo` .
e.g.
{{ getenv "HOME" }}
2015-04-04 05:12:11 -04:00
### in
2015-08-04 14:00:08 -04:00
Checks if an element is in an array (or slice) and returns a boolean.
The elements supported are strings, integers and floats (only float64 will match as expected).
In addition, it can also check if a substring exists in a string.
2014-08-30 00:57:38 -04:00
2014-09-03 00:12:26 -04:00
e.g.
2014-08-30 00:57:38 -04:00
2015-04-04 05:12:11 -04:00
{{ if in .Params.tags "Git" }}Follow me on GitHub!{{ end }}
2014-08-30 00:57:38 -04:00
2015-04-04 05:12:11 -04:00
or
2014-12-28 21:33:12 -05:00
2015-04-04 05:12:11 -04:00
{{ if in "this string contains a substring" "substring" }}Substring found!{{ end }}
2014-12-28 21:33:12 -05:00
2015-04-04 05:12:11 -04:00
### intersect
2015-08-04 14:00:08 -04:00
Given two arrays (or slices), this function will return the common elements in the arrays.
The elements supported are strings, integers and floats (only float64).
2014-12-28 21:33:12 -05:00
2015-08-04 14:00:08 -04:00
A useful example of this functionality is a 'similar posts' block.
Create a list of links to posts where any of the tags in the current post match any tags in other posts.
Add operator argument to `where` template function
It allows to use `where` template function like SQL `where` clause.
For example,
{{ range where .Data.Pages "Type" "!=" "post" }}
{{ .Content }}
{{ end }}
Now these operators are implemented:
=, ==, eq, !=, <>, ne, >=, ge, >, gt, <=, le, <, lt, in, not in
It also fixes `TestWhere` more readable
2015-01-04 00:24:58 -05:00
e.g.
2015-04-04 05:12:11 -04:00
< ul >
{{ $page_link := .Permalink }}
{{ $tags := .Params.tags }}
2015-11-30 14:52:30 -05:00
{{ range .Site.Pages }}
2015-04-04 05:12:11 -04:00
{{ $page := . }}
{{ $has_common_tags := intersect $tags .Params.tags | len | lt 0 }}
{{ if and $has_common_tags (ne $page_link $page.Permalink) }}
< li > < a href = "{{ $page.Permalink }}" > {{ $page.Title }}< / a > < / li >
{{ end }}
2014-08-30 00:57:38 -04:00
{{ end }}
2015-04-04 05:12:11 -04:00
< / ul >
2014-08-30 00:57:38 -04:00
2014-12-11 15:29:22 -05:00
2015-04-04 05:12:11 -04:00
### isset
2015-08-04 14:00:08 -04:00
Returns true if the parameter is set.
2015-04-04 05:12:11 -04:00
Takes either a slice, array or channel and an index or a map and a key as input.
2014-12-11 15:29:22 -05:00
2015-04-04 05:12:11 -04:00
e.g. `{{ if isset .Params "project_url" }} {{ index .Params "project_url" }}{{ end }}`
2014-12-11 15:29:22 -05:00
2015-05-22 16:17:45 -04:00
### seq
2015-08-04 14:00:08 -04:00
Creates a sequence of integers. It's named and used as GNU's seq.
2015-05-22 16:17:45 -04:00
Some examples:
* `3` => `1, 2, 3`
* `1 2 4` => `1, 3`
* `-3` => `-1, -2, -3`
* `1 4` => `1, 2, 3, 4`
* `1 -2` => `1, 0, -1, -2`
2014-12-11 15:29:22 -05:00
### sort
2015-08-04 14:00:08 -04:00
Sorts maps, arrays and slices, returning a sorted slice.
A sorted array of map values will be returned, with the keys eliminated.
There are two optional arguments, which are `sortByField` and `sortAsc` .
If left blank, sort will sort by keys (for maps) in ascending order.
2014-12-11 15:29:22 -05:00
Works on [lists ](/templates/list/ ), [taxonomies ](/taxonomies/displaying/ ), [terms ](/templates/terms/ ), [groups ](/templates/list/ )
e.g.
2015-01-18 15:25:20 -05:00
2014-12-11 15:29:22 -05:00
// Front matter
+++
tags: [ "tag3", "tag1", "tag2" ]
+++
// Site config
+++
[params.authors]
[params.authors.Derek]
"firstName" = "Derek"
"lastName" = "Perkins"
[params.authors.Joe]
"firstName" = "Joe"
"lastName" = "Bergevin"
[params.authors.Tanner]
"firstName" = "Tanner"
"lastName" = "Linsley"
+++
// Use default sort options - sort by key / ascending
Tags: {{ range sort .Params.tags }}{{ . }} {{ end }}
// Outputs Tags: tag1 tag2 tag3
// Sort by value / descending
Tags: {{ range sort .Params.tags "value" "desc" }}{{ . }} {{ end }}
// Outputs Tags: tag3 tag2 tag1
// Use default sort options - sort by value / descending
Authors: {{ range sort .Site.Params.authors }}{{ .firstName }} {{ end }}
// Outputs Authors: Derek Joe Tanner
// Use default sort options - sort by value / descending
Authors: {{ range sort .Site.Params.authors "lastName" "desc" }}{{ .lastName }} {{ end }}
// Outputs Authors: Perkins Linsley Bergevin
2015-04-04 05:12:11 -04:00
### where
Filters an array to only elements containing a matching value for a given field.
Works on [lists ](/templates/list/ ), [taxonomies ](/taxonomies/displaying/ ), [terms ](/templates/terms/ ), [groups ](/templates/list/ )
2014-10-08 12:05:22 -04:00
e.g.
2014-12-04 11:26:12 -05:00
2015-04-04 05:12:11 -04:00
{{ range where .Data.Pages "Section" "post" }}
{{ .Content }}
{{ end }}
2014-12-04 11:26:12 -05:00
2015-04-04 05:12:11 -04:00
It can be used with dot chaining second argument to refer a nested element of a value.
2014-12-04 11:26:12 -05:00
2015-04-04 05:12:11 -04:00
e.g.
2014-10-08 12:05:22 -04:00
2015-04-04 05:12:11 -04:00
// Front matter on some pages
+++
series: golang
+++
2014-10-08 12:05:22 -04:00
2015-11-30 14:52:30 -05:00
{{ range where .Site.Pages "Params.series" "golang" }}
2015-04-04 05:12:11 -04:00
{{ .Content }}
{{ end }}
It can also be used with an operator like `!=` , `>=` , `in` etc. Without an operator (like above), `where` compares a given field with a matching value in a way like `=` is specified.
2014-10-08 12:05:22 -04:00
e.g.
2014-12-04 11:26:12 -05:00
2015-04-04 05:12:11 -04:00
{{ range where .Data.Pages "Section" "!=" "post" }}
{{ .Content }}
{{ end }}
Following operators are now available
- `=` , `==` , `eq` : True if a given field value equals a matching value
- `!=` , `<>` , `ne` : True if a given field value doesn't equal a matching value
- `>=` , `ge` : True if a given field value is greater than or equal to a matching value
- `>` , `gt` : True if a given field value is greater than a matching value
- `<=` , `le` : True if a given field value is lesser than or equal to a matching value
- `<` , `lt` : True if a given field value is lesser than a matching value
- `in` : True if a given field value is included in a matching value. A matching value must be an array or a slice
- `not in` : True if a given field value isn't included in a matching value. A matching value must be an array or a slice
*`where` and `first` can be stacked, e.g.:*
{{ range first 5 (where .Data.Pages "Section" "post") }}
{{ .Content }}
2014-10-08 12:05:22 -04:00
{{ end }}
2015-08-10 22:33:13 -04:00
### Unset field
Filter only work for set fields. To check whether a field is set or exist, use operand `nil` .
This can be useful to filter a small amount of pages from a large pool. Instead of set field on all pages, you can set field on required pages only.
Only following operators are available for `nil`
- `=` , `==` , `eq` : True if the given field is not set.
- `!=` , `<>` , `ne` : True if the given field is set.
e.g.
{{ range where .Data.Pages ".Params.specialpost" "!=" nil }}
{{ .Content }}
{{ end }}
2016-03-21 19:28:42 -04:00
## Files
2016-03-31 17:16:42 -04:00
### readDir
Gets a directory listing from a directory relative to the current project working dir.
So, If the project working dir has a single file named `README.txt` :
`{{ range (readDir ".") }}{{ .Name }}{{ end }}` → "README.txt"
2016-03-21 19:28:42 -04:00
### readFile
Reads a file from disk and converts it into a string. Note that the filename must be relative to the current project working dir.
So, if you have a file with the name `README.txt` in the root of your project with the content `Hugo Rocks!` :
`{{readFile "README.txt"}}` → `"Hugo Rocks!"`
2014-02-18 18:35:27 -05:00
## Math
2015-01-17 02:45:53 -05:00
< table class = "table table-bordered" >
< thead >
< tr >
< th > Function< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < code > add< / code > < / td >
< td > Adds two integers.< / td >
< td > < code > {{add 1 2}}< / code > → 3< / td >
< / tr >
< tr >
< td > < code > div< / code > < / td >
< td > Divides two integers.< / td >
< td > < code > {{div 6 3}}< / code > → 2< / td >
< / tr >
< tr >
< td > < code > mod< / code > < / td >
< td > Modulus of two integers.< / td >
< td > < code > {{mod 15 3}}< / code > → 0< / td >
< / tr >
< tr >
< td > < code > modBool< / code > < / td >
< td > Boolean of modulus of two integers. < code > true< / code > if modulus is 0.< / td >
< td > < code > {{modBool 15 3}}< / code > → true< / td >
< / tr >
2015-04-04 05:12:11 -04:00
< tr >
< td > < code > mul< / code > < / td >
< td > Multiplies two integers.< / td >
< td > < code > {{mul 2 3}}< / code > → 6< / td >
< / tr >
< tr >
< td > < code > sub< / code > < / td >
< td > Subtracts two integers.< / td >
< td > < code > {{sub 3 2}}< / code > → 1< / td >
< / tr >
2015-01-17 02:45:53 -05:00
< / tbody >
< / table >
2014-02-18 18:35:27 -05:00
2016-01-15 18:06:32 -05:00
## Numbers
### int
2016-03-28 11:04:29 -04:00
Creates an `int` .
2016-01-15 18:06:32 -05:00
e.g.
2016-03-28 11:04:29 -04:00
* `{{ int "123" }}` → 123
2014-02-18 18:35:27 -05:00
## Strings
2015-04-04 05:12:11 -04:00
### chomp
Removes any trailing newline characters. Useful in a pipeline to remove newlines added by other processing (including `markdownify` ).
2015-12-10 15:01:19 -05:00
e.g., `{{chomp "<p>Blockhead</p>\n"}}` → `"<p>Blockhead</p>"`
2015-04-04 05:12:11 -04:00
### dateFormat
2015-08-04 14:00:08 -04:00
Converts the textual representation of the datetime into the other form or returns it of Go `time.Time` type value.
These are formatted with the layout string.
2015-04-04 05:12:11 -04:00
2015-12-23 11:31:07 -05:00
e.g. `{{ dateFormat "Monday, Jan 2, 2006" "2015-01-21" }}` → "Wednesday, Jan 21, 2015"
2015-04-04 05:12:11 -04:00
2016-02-24 18:52:11 -05:00
### emojify
Runs the string through the Emoji emoticons processor. The result will be declared as "safe" so Go templates will not filter it.
See the [Emoji cheat sheet ](http://www.emoji-cheat-sheet.com/ ) for available emoticons.
e.g. `{{ "I :heart: Hugo" | emojify }}`
2015-04-04 05:12:11 -04:00
### highlight
2015-08-04 14:00:08 -04:00
Takes a string of code and a language, uses Pygments to return the syntax highlighted code in HTML.
Used in the [highlight shortcode ](/extras/highlighting/ ).
2015-04-04 05:12:11 -04:00
2016-02-05 01:05:04 -05:00
### humanize
Humanize returns the humanized version of a string with the first letter capitalized.
e.g.
```
{{humanize "my-first-post"}} → "My first post"
{{humanize "myCamelPost"}} → "My camel post"
```
2015-04-04 05:12:11 -04:00
### lower
2015-08-04 14:00:08 -04:00
Converts all characters in string to lowercase.
2015-04-04 05:12:11 -04:00
e.g. `{{lower "BatMan"}}` → "batman"
### markdownify
2015-10-16 17:57:56 -04:00
Runs the string through the Markdown processor. The result will be declared as "safe" so Go templates will not filter it.
2015-04-04 05:12:11 -04:00
e.g. `{{ .Title | markdownify }}`
2016-03-03 09:53:15 -05:00
### plainify
Strips any HTML and returns the plain text version.
e.g. `{{ "<b>BatMan</b>" | plainify }}` → "BatMan"
2015-09-22 16:24:24 -04:00
### pluralize
Pluralize the given word with a set of common English pluralization rules.
e.g. `{{ "cat" | pluralize }}` → "cats"
2015-04-04 05:12:11 -04:00
### replace
2015-08-04 14:00:08 -04:00
Replaces all occurrences of the search string with the replacement string.
2015-04-04 05:12:11 -04:00
e.g. `{{ replace "Batman and Robin" "Robin" "Catwoman" }}` → "Batman and Catwoman"
2014-02-18 18:35:27 -05:00
2016-02-08 17:57:52 -05:00
### replaceRE
Replaces all occurrences of a regular expression with the replacement pattern.
e.g. `{{ replaceRE "^https?://([^/]+).*" "$1" "http://gohugo.io/docs" }}` → "gohugo.io"
e.g. `{{ "http://gohugo.io/docs" | replaceRE "^https?://([^/]+).*" "$1" }}` → "gohugo.io"
2015-03-18 02:44:12 -04:00
### safeHTML
2015-01-20 01:41:22 -05:00
Declares the provided string as a "safe" HTML document fragment
so Go html/template will not filter it. It should not be used
for HTML from a third-party, or HTML with unclosed tags or comments.
2014-02-18 18:35:27 -05:00
2015-01-20 01:41:22 -05:00
Example: Given a site-wide `config.toml` that contains this line:
2014-02-18 18:35:27 -05:00
2015-01-20 01:41:22 -05:00
copyright = "© 2015 Jane Doe. < a href = \"http://creativecommons.org/licenses/by/4.0/ \"> Some rights reserved</ a > ."
2015-03-18 02:44:12 -04:00
`{{ .Site.Copyright | safeHTML }}` would then output:
2015-01-20 01:41:22 -05:00
> © 2015 Jane Doe. <a href="http://creativecommons.org/licenses/by/4.0/">Some rights reserved</a>.
2015-03-18 02:44:12 -04:00
However, without the `safeHTML` function, html/template assumes
2015-01-20 01:41:22 -05:00
`.Site.Copyright` to be unsafe, escaping all HTML tags,
rendering the whole string as plain-text like this:
< blockquote >
< p > © 2015 Jane Doe. < a href=" http://creativecommons.org/licenses/by/4.0/" > Some rights reserved< /a> .< / p >
< / blockquote >
<!--
2015-03-18 02:44:12 -04:00
### safeHTMLAttr
2015-01-20 01:41:22 -05:00
Declares the provided string as a "safe" HTML attribute
from a trusted source, for example, ` dir="ltr"` ,
so Go html/template will not filter it.
Example: Given a site-wide `config.toml` that contains this menu entry:
[[menu.main]]
name = "IRC: #golang at freenode"
url = "irc://irc.freenode.net/#golang"
2015-03-18 02:44:12 -04:00
* `<a href="{{ .URL }}">` ⇒ `<a href="#ZgotmplZ">` (Bad!)
* `<a {{ printf "href=%q" .URL | safeHTMLAttr }}>` ⇒ `<a href="irc://irc.freenode.net/#golang">` (Good!)
2015-01-20 01:41:22 -05:00
-->
2015-04-04 05:12:11 -04:00
2015-03-18 02:44:12 -04:00
### safeCSS
2015-01-20 01:41:22 -05:00
Declares the provided string as a known "safe" CSS string
so Go html/templates will not filter it.
"Safe" means CSS content that matches any of:
1. The CSS3 stylesheet production, such as `p { color: purple }` .
2. The CSS3 rule production, such as `a[href=~"https:"].foo#bar` .
3. CSS3 declaration productions, such as `color: red; margin: 2px` .
4. The CSS3 value production, such as `rgba(0, 0, 255, 127)` .
Example: Given `style = "color: red;"` defined in the front matter of your `.md` file:
2015-03-18 02:44:12 -04:00
* `<p style="{{ .Params.style | safeCSS }}">…</p>` ⇒ `<p style="color: red;">…</p>` (Good!)
2015-01-20 01:41:22 -05:00
* `<p style="{{ .Params.style }}">…</p>` ⇒ `<p style="ZgotmplZ">…</p>` (Bad!)
Note: "ZgotmplZ" is a special value that indicates that unsafe content reached a
CSS or URL context.
2015-11-15 15:30:57 -05:00
### safeJS
Declares the provided string as a known "safe" Javascript string so Go
html/templates will not escape it. "Safe" means the string encapsulates a known
safe EcmaScript5 Expression, for example, `(x + y * z())` . Template authors
are responsible for ensuring that typed expressions do not break the intended
precedence and that there is no statement/expression ambiguity as when passing
an expression like `{ foo:bar() }\n['foo']()` , which is both a valid Expression
and a valid Program with a very different meaning.
Example: Given `hash = "619c16f"` defined in the front matter of your `.md` file:
* `<script>var form_{{ .Params.hash | safeJS }};…</script>` ⇒ `<script>var form_619c16f;…</script>` (Good!)
* `<script>var form_{{ .Params.hash }};…</script>` ⇒ `<script>var form_"619c16f";…</script>` (Bad!)
2015-09-22 16:31:02 -04:00
### singularize
2015-09-22 16:33:41 -04:00
Singularize the given word with a set of common English singularization rules.
2015-09-22 16:31:02 -04:00
e.g. `{{ "cats" | singularize }}` → "cat"
2015-05-22 16:20:35 -04:00
### slicestr
2015-08-04 14:00:08 -04:00
Slicing in `slicestr` is done by specifying a half-open range with two indices, `start` and `end` .
For example, 1 and 4 creates a slice including elements 1 through 3.
The `end` index can be omitted; it defaults to the string's length.
2015-05-22 16:20:35 -04:00
2015-08-04 14:00:08 -04:00
e.g.
2015-05-22 16:20:35 -04:00
* `{{slicestr "BatMan" 3}}` → "Man"
* `{{slicestr "BatMan" 0 3}}` → "Bat"
2016-03-28 03:27:29 -04:00
### split
Split a string into substrings separated by a delimiter.
e.g.
* `{{split "tag1,tag2,tag3" "," }}` → ["tag1" "tag2" "tag3"]
2016-01-15 18:06:32 -05:00
### string
Creates a `string` .
e.g.
* `{{string "BatMan"}}` → "BatMan"
2015-05-22 16:36:17 -04:00
### substr
2015-08-04 14:00:08 -04:00
Extracts parts of a string, beginning at the character at the specified
position, and returns the specified number of characters.
2015-05-22 16:36:17 -04:00
2015-08-04 14:00:08 -04:00
It normally takes two parameters: `start` and `length` .
It can also take one parameter: `start` , i.e. `length` is omitted, in which case
the substring starting from start until the end of the string will be returned.
2015-05-22 16:36:17 -04:00
2015-08-04 14:00:08 -04:00
To extract characters from the end of the string, use a negative start number.
2015-05-22 16:36:17 -04:00
2015-08-04 14:00:08 -04:00
In addition, borrowing from the extended behavior described at http://php.net/substr,
if `length` is given and is negative, then that many characters will be omitted from
the end of string.
2015-05-22 16:36:17 -04:00
e.g.
* `{{substr "BatMan" 0 -3}}` → "Bat"
* `{{substr "BatMan" 3 3}}` → "Man"
2015-05-11 13:08:52 -04:00
### title
2015-08-04 14:00:08 -04:00
Converts all characters in string to titlecase.
2015-05-11 13:08:52 -04:00
e.g. `{{title "BatMan"}}` → "Batman"
### trim
2015-08-04 14:00:08 -04:00
Returns a slice of the string with all leading and trailing characters contained in cutset removed.
2015-05-11 13:08:52 -04:00
e.g. `{{ trim "++Batman--" "+-" }}` → "Batman"
### upper
2015-08-04 14:00:08 -04:00
Converts all characters in string to uppercase.
2015-05-11 13:08:52 -04:00
e.g. `{{upper "BatMan"}}` → "BATMAN"
2015-09-20 12:15:45 -04:00
### countwords
`countwords` tries to convert the passed content to a string and counts each word
in it. The template functions works similar to [.WordCount ]({{< relref "templates/variables.md#page-variables" >}} ).
```html
{{ "Hugo is a static site generator." | countwords }}
<!-- outputs a content length of 6 words. -->
```
### countrunes
Alternatively to counting all words , `countrunes` determines the number of runes in the content and excludes any whitespace. This can become useful if you have to deal with
CJK-like languages.
```html
{{ "Hello, 世界" | countrunes }}
<!-- outputs a content length of 8 runes. -->
```
2015-05-11 13:08:52 -04:00
2016-03-07 15:40:47 -05:00
### md5
`md5` hashes the given input and returns its MD5 checksum.
```html
{{ md5 "Hello world, gophers!" }}
<!-- returns the string "b3029f756f98f79e7f1b7f1d1f0dd53b" -->
```
This can be useful if you want to use Gravatar for generating a unique avatar:
```html
< img src = "https://www.gravatar.com/avatar/{{ md5 " your @ email . com " } } ? s = 100&d=identicon" >
```
### sha1
`sha1` hashes the given input and returns its SHA1 checksum.
```html
{{ sha1 "Hello world, gophers!" }}
<!-- returns the string "c8b5b0e33d408246e30f53e32b8f7627a7a649d4" -->
```
2015-08-04 14:00:08 -04:00
## URLs
2015-05-11 13:08:52 -04:00
### absURL, relURL
Both `absURL` and `relURL` considers the configured value of `baseURL` , so given a `baseURL` set to `http://mysite.com/hugo/` :
* `{{ "mystyle.css" | absURL }}` → "http://mysite.com/hugo/mystyle.css"
* `{{ "mystyle.css" | relURL }}` → "/hugo/mystyle.css"
2015-05-22 17:43:12 -04:00
* `{{ "http://gohugo.io/" | relURL }}` → "http://gohugo.io/"
* `{{ "http://gohugo.io/" | absURL }}` → "http://gohugo.io/"
2015-05-11 13:08:52 -04:00
2015-05-22 17:43:12 -04:00
The last two examples may look funky, but is useful if you, say, have a list of images, some of them hosted externally, some locally:
```
< script type = "application/ld+json" >
{
"@context" : "http://schema.org",
"@type" : "BlogPosting",
"image" : {{ apply .Params.images "absURL" "." }}
}
< / script >
```
The above also exploits the fact that the Go template parser JSON-encodes objects inside `script` tags.
**Note:** These functions are smart about missing slashes, but will not add one to the end if not present.
2015-05-11 13:08:52 -04:00
### ref, relref
Looks up a content page by relative path or logical name to return the permalink (`ref`) or relative permalink (`relref`). Requires a Node or Page object (usually satisfied with `.` ). Used in the [`ref` and `relref` shortcodes ]({{% ref "extras/crossreferences.md" %}} ).
e.g. {{ ref . "about.md" }}
2015-04-04 05:12:11 -04:00
2015-03-18 02:44:12 -04:00
### safeURL
2015-01-20 01:41:22 -05:00
Declares the provided string as a "safe" URL or URL substring (see [RFC 3986][]).
A URL like `javascript:checkThatFormNotEditedBeforeLeavingPage()` from a trusted
source should go in the page, but by default dynamic `javascript:` URLs are
filtered out since they are a frequently exploited injection vector.
[RFC 3986]: http://tools.ietf.org/html/rfc3986
2015-03-18 02:44:12 -04:00
Without `safeURL` , only the URI schemes `http:` , `https:` and `mailto:`
2015-01-20 02:24:47 -05:00
are considered safe by Go. If any other URI schemes, e.g. `irc:` and
`javascript:` , are detected, the whole URL would be replaced with
`#ZgotmplZ` . This is to "defang" any potential attack in the URL,
rendering it useless.
2015-01-20 01:41:22 -05:00
Example: Given a site-wide `config.toml` that contains this menu entry:
[[menu.main]]
name = "IRC: #golang at freenode"
url = "irc://irc.freenode.net/#golang"
The following template:
< ul class = "sidebar-menu" >
{{ range .Site.Menus.main }}
2015-03-18 02:44:12 -04:00
< li > < a href = "{{ .URL }}" > {{ .Name }}< / a > < / li >
2015-01-20 01:41:22 -05:00
{{ end }}
< / ul >
would produce `<li><a href="#ZgotmplZ">IRC: #golang at freenode</a></li>`
for the `irc://…` URL.
2015-03-18 02:44:12 -04:00
To fix this, add ` | safeURL` after `.URL` on the 3rd line, like this:
2015-01-20 01:41:22 -05:00
2015-03-18 02:44:12 -04:00
< li > < a href = "{{ .URL | safeURL }}" > {{ .Name }}< / a > < / li >
2015-01-20 01:41:22 -05:00
With this change, we finally get `<li><a href="irc://irc.freenode.net/#golang">IRC: #golang at freenode</a></li>`
as intended.
2014-11-24 18:47:08 -05:00
2014-02-18 18:35:27 -05:00
2015-04-04 05:12:11 -04:00
### urlize
Takes a string and sanitizes it for usage in URLs, converts spaces to "-".
2014-11-25 03:07:18 -05:00
2015-04-04 05:12:11 -04:00
e.g. `<a href="/tags/{{ . | urlize }}">{{ . }}</a>`
2014-11-25 03:07:18 -05:00
2014-12-09 22:46:33 -05:00
2015-05-22 12:43:29 -04:00
## Content Views
### Render
Takes a view to render the content with. The view is an alternate layout, and should be a file name that points to a template in one of the locations specified in the documentation for [Content Views ](/templates/views ).
This function is only available on a piece of content, and in list context.
This example could render a piece of content using the content view located at `/layouts/_default/summary.html` :
{{ range .Data.Pages }}
{{ .Render "summary"}}
{{ end }}
2014-12-09 22:46:33 -05:00
## Advanced
### apply
Given a map, array, or slice, returns a new slice with a function applied over it. Expects at least three parameters, depending on the function being applied. The first parameter is the sequence to operate on; the second is the name of the function as a string, which must be in the Hugo function map (generally, it is these functions documented here). After that, the parameters to the applied function are provided, with the string `"."` standing in for each element of the sequence the function is to be applied against. An example is in order:
+++
names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ]
+++
{{ apply .Params.names "urlize" "." }} → [ "derek-perkins", "joe-bergevin", "tanner-linsley" ]
This is roughly equivalent to:
{{ range .Params.names }}{{ . | urlize }}{{ end }}
However, it isn’ t possible to provide the output of a range to the `delimit` function, so you need to `apply` it. A more complete example should explain this. Let's say you have two partials for displaying tag links in a post, "post/tag/list.html" and "post/tag/link.html", as shown below.
<!-- post/tag/list.html -->
{{ with .Params.tags }}
< div class = "tags-list" >
Tags:
{{ $len := len . }}
{{ if eq $len 1 }}
{{ partial "post/tag/link" (index . 0) }}
{{ else }}
{{ $last := sub $len 1 }}
{{ range first $last . }}
{{ partial "post/tag/link" . }},
{{ end }}
{{ partial "post/tag/link" (index . $last) }}
{{ end }}
< / div >
{{ end }}
<!-- post/tag/link.html -->
< a class = "post-tag post-tag-{{ . | urlize }}" href = "/tags/{{ . | urlize }}" > {{ . }}< / a >
This works, but the complexity of "post/tag/list.html" is fairly high; the Hugo template needs to perform special behaviour for the case where there’ s only one tag, and it has to treat the last tag as special. Additionally, the tag list will be rendered something like "Tags: tag1 , tag2 , tag3" because of the way that the HTML is generated and it is interpreted by a browser.
This is Hugo. We have a better way. If this were your "post/tag/list.html" instead, all of those problems are fixed automatically (this first version separates all of the operations for ease of reading; the combined version will be shown after the explanation).
<!-- post/tag/list.html -->
2016-02-17 07:36:28 -05:00
{{ with .Params.tags }}
2014-12-09 22:46:33 -05:00
< div class = "tags-list" >
Tags:
{{ $sort := sort . }}
{{ $links := apply $sort "partial" "post/tag/link" "." }}
{{ $clean := apply $links "chomp" "." }}
{{ delimit $clean ", " }}
< / div >
{{ end }}
In this version, we are now sorting the tags, converting them to links with "post/tag/link.html", cleaning off stray newlines, and joining them together in a delimited list for presentation. That can also be written as:
<!-- post/tag/list.html -->
2016-02-17 07:36:28 -05:00
{{ with .Params.tags }}
2014-12-09 22:46:33 -05:00
< div class = "tags-list" >
Tags:
{{ delimit (apply (apply (sort .) "partial" "post/tag/link" ".") "chomp" ".") ", " }}
< / div >
{{ end }}
`apply` does not work when receiving the sequence as an argument through a pipeline.
2015-09-12 15:45:12 -04:00
***
### base64Encode and base64Decode
2015-10-16 17:57:56 -04:00
`base64Encode` and `base64Decode` let you easily decode content with a base64 encoding and vice versa through pipes. Let's take a look at an example:
2015-09-12 15:45:12 -04:00
{{ "Hello world" | base64Encode }}
<!-- will output "SGVsbG8gd29ybGQ=" and -->
{{ "SGVsbG8gd29ybGQ=" | base64Decode }}
<!-- becomes "Hello world" again. -->
You can also pass other datatypes as argument to the template function which tries
to convert them. Now we use an integer instead of a string:
{{ 42 | base64Encode | base64Decode }}
<!-- will output "42". Both functions always return a string. -->
**Tip:** Using base64 to decode and encode becomes really powerful if we have to handle
responses of APIs.
{{ $resp := getJSON "https://api.github.com/repos/spf13/hugo/readme" }}
{{ $resp.content | base64Decode | markdownify }}
2015-11-20 16:24:22 -05:00
The response of the GitHub API contains the base64-encoded version of the [README.md ](https://github.com/spf13/hugo/blob/master/README.md ) in the Hugo repository. Now we can decode it and parse the Markdown. The final output will look similar to the rendered version on GitHub.