Miscellaneous (MS)

Go templates are lightweight but extensible. Go itself supplies built-in functions, including comparison operators and other basic tools. These are listed in the Go template documentation. Hugo has added additional functions to the basic template logic.

transform.Unmarshal

transform.Unmarshal (alias unmarshal) parses the input and converts it into a map or an array. Supported formats are JSON, TOML, YAML and CSV. Read More »

path.Base

Base returns the last element of a path. Read More »

path.Dir

Dir returns all but the last element of a path. Read More »

path.Ext

Ext returns the file name extension of a path. Read More »

path.Join

Join path elements into a single path. Read More »

path.Split

Split path immediately following the final slash. Read More »

complement

collections.Complement (alias complement) gives the elements of a collection that are not in any of the others. Read More »

symdiff

collections.SymDiff (alias symdiff) returns the symmetric difference of two collections. Read More »

templates.Exists

Checks whether a template file exists under the given path relative to the layouts directory. Read More »

anchorize

Takes a string and sanitizes it the same way as Blackfriday does for markdown headers. Read More »

append

append appends one or more values to a slice and returns the resulting slice. Read More »

group

group groups a list of pages. Read More »

os.Stat

Gets a file information of a given path. Read More »

strings.RuneCount

Determines the number of runes in a string. Read More »

strings.Repeat

Returns a string consisting of count copies of the string s. Read More »

lang.Merge

Merge missing translations from other languages. Read More »

errorf

Log ERROR and fail the build from the templates. Read More »

float

Creates a float from the argument passed into the function. Read More »

urls.Parse

Parse parses a given url, which may be relative or absolute, into a URL structure. Read More »

cond

Return one of two arguments, depending on the value of a third argument. Read More »

fileExists

Checks whether a file exists under the given path. Read More »

ge

Returns the boolean truth of arg1 >= arg2. Read More »

gt

Returns the boolean truth of arg1 > arg2. Read More »

le

Returns the boolean truth of arg1 <= arg2. Read More »

lt

Returns the boolean truth of arg1 < arg2. Read More »

ne

Returns the boolean truth of arg1 != arg2. Read More »

.AddDate

Returns the time corresponding to adding the given number of years, months, and days passed to the function. Read More »

.Format

Formats built-in Hugo dates—.Date, .PublishDate, and .Lastmod—according to Go’s layout string. Read More »

.Get

Accesses positional and ordered parameters in shortcode declaration. Read More »

.GetPage

Gets a Page of a given path. Read More »

.HasMenuCurrent

.HasMenuCurrent is a method in Page object returning a boolean value. It returns true if the PAGE is the same object as the .Page in one of the children menu entries under MENUENTRY in a given MENU. You can find its example use in menu templates. Read More »

.IsMenuCurrent

.IsMenuCurrent is a method in Page object returning a boolean value. It returns true if the PAGE is the same object as the .Page in MENUENTRY in a given MENU. You can find its example use in menu templates. Read More »

.Param

Calls page or site variables into your template. Read More »

.Render

Takes a view to apply when rendering content. Read More »

.Scratch

Acts as a “scratchpad” to allow for writable page- or shortcode-scoped variables. Read More »

.Unix

.Unix returns the local Time corresponding to the given Unix time, sec seconds and nsec nanoseconds since January 1, 1970 UTC. Read More »

Math

Hugo provides nine mathematical operators in templates. Read More »

absLangURL

Adds the absolute URL with correct language prefix according to site configuration for multilingual. Read More »

absURL

Creates an absolute URL based on the configured baseURL. Read More »

after

after slices an array to only the items after the Nth item. Read More »

apply

Given a map, array, or slice, apply returns a new slice with a function applied over it. Read More »

base64

base64Encode and base64Decode let you easily decode content with a base64 encoding and vice versa through pipes. Read More »

chomp

Removes any trailing newline characters. Read More »

countrunes

Determines the number of runes in a string excluding any whitespace. Read More »

countwords

Counts the number of words in a string. Read More »

dateFormat

Converts the textual representation of the datetime into the specified format. Read More »

default

Allows setting a default value that can be returned if a first value is not set. Read More »

delimit

Loops through any array, slice, or map and returns a string of all the values separated by a delimiter. Read More »

dict

Creates a dictionary from a list of key and value pairs. Read More »

echoParam

Prints a parameter if it is set. Read More »

emojify

Runs a string through the Emoji emoticons processor. Read More »

eq

Returns the boolean truth of arg1 == arg2. Read More »

findRE

Returns a list of strings that match the regular expression. Read More »

first

Slices an array to only the first N elements. Read More »

getenv

Returns the value of an environment variable. Read More »

hasprefix

Tests whether a string begins with prefix. Read More »

highlight

Takes a string of code and language declaration and uses Pygments to return syntax-highlighted HTML with inline-styles. Read More »

htmlEscape

Returns the given string with the reserved HTML codes escaped. Read More »

htmlUnescape

Returns the given string with HTML escape codes un-escaped. Read More »

humanize

Returns the humanized version of an argument with the first letter capitalized. Read More »

i18n

Translates a piece of content based on your i18n configuration files. Read More »

imageConfig

Parses the image and returns the height, width, and color model. Read More »

in

Checks if an element is in an array or slice–or a substring in a string—and returns a boolean. Read More »

index

Looks up the index(es) or key(s) of the data structure passed into it. Read More »

int

Creates an int from the argument passed into the function. Read More »

intersect

Returns the common elements of two arrays or slices. Read More »

isset

Returns true if the parameter is set. Read More »

jsonify

Encodes a given object to JSON. Read More »

lang.NumFmt

Formats a number with a given precision using the requested negative, decimal, and grouping options. The options parameter is a string consisting of <negative> <decimal> <grouping>. Read More »

last

slices an array to only the last Nth elements. Read More »

len

Returns the length of a variable according to its type. Read More »

lower

Converts all characters in the provided string to lowercase. Read More »

markdownify

Runs the provided string through the Markdown processor. Read More »

md5

hashes the given input and returns its MD5 checksum. Read More »

now

Returns the current local time Read More »

partialCached

Allows for caching of partials that do not need to be re-rendered on every invocation. Read More »

plainify

Strips any HTML and returns the plain text version of the provided string. Read More »

pluralize

Pluralizes the given word according to a set of common English pluralization rules Read More »

print

Prints the default representation of the given argument using the standard fmt.Print function. Read More »

printf

Formats a string using the standard fmt.Sprintf function. Read More »

println

Prints the default representation of the given argument using the standard fmt.Print function and enforces a linebreak. Read More »

querify

Takes a set of key-value pairs and returns a query string to be appended to URLs. Read More »

range

Iterates over a map, array, or slice. Read More »

readDir

Gets a directory listing from a directory relative to the current working directory. Read More »

readFile

Reads a file from disk relative to the current project working directory and returns a string. Read More »

ref

Looks up a content page by logical name. Read More »

relLangURL

Adds the relative URL with correct language prefix according to site configuration for multilingual. Read More »

relURL

Given a string, prepends the relative URL according to a page’s position in the project directory structure. Read More »

relref

Looks up a content page by relative path. Read More »

replace

Replaces all occurrences of the search string with the replacement string. Read More »

replaceRE

Replaces all occurrences of a regular expression with the replacement pattern. Read More »

safeCSS

Declares the provided string as a known “safe” CSS string. Read More »

safeHTML

Declares a provided string as a “safe” HTML document to avoid escaping by Go templates. Read More »

safeHTMLAttr

Declares the provided string as a safe HTML attribute. Read More »

safeJS

Declares the provided string as a known safe JavaScript string. Read More »

safeURL

Declares the provided string as a safe URL or URL substring. Read More »

seq

Creates a sequence of integers. Read More »

sha

Hashes the given input and returns either an SHA1 or SHA256 checksum. Read More »

shuffle

Returns a random permutation of a given array or slice. Read More »

singularize

Converts a word according to a set of common English singularization rules. Read More »