Functions

The site function provides global access the same data as .Site page method Read More »

Returns the number of non-overlapping instances of a substring within a string. Read More »

Compute the cryptographic checksum of a message. Read More »

Renders markup to HTML. Read More »

Determine whether or not a given string ends with the provided trailing suffix string. Read More »

merge deep merges two maps and returns the resulting map. Read More »

The hugo function provides easy access to Hugo-related data. Read More »

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 »

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

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

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

Join path elements into a single path. Read More »

Split path immediately following the final slash. Read More »

Reports if a value is a map. Read More »

Reports if a value is a slice. Read More »

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

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

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

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

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

group groups a list of pages. Read More »

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

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

Returns INPUT repeated COUNT times. Read More »

Merge missing translations from other languages. Read More »

Log ERROR or WARNING from the templates. Read More »

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

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

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

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

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

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

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

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

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

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

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

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

Gets a Page of a given path. Read More »

.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 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 »

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

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

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

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

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

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

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

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

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

Removes any trailing newline characters. Read More »

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

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

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

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

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

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

Prints a parameter if it is set. Read More »

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

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

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

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

Returns the value of an environment variable. Read More »

Tests whether a string begins with prefix. Read More »

Takes a string of code and language declaration and uses Chroma to return syntax-highlighted HTML. Read More »

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

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

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

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

The images namespace provides a list of filters and other image related functions. Read More »

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

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

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

Returns the common elements of two arrays or slices, in the same order as the first array. Read More »

Returns true if the parameter is set. Read More »

Encodes a given object to JSON. Read More »

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 »

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

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

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

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

Hugo provides nine mathematical operators in templates. Read More »

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

Returns the current local time Read More »

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

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

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

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

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

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

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

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

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

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

Returns the absolute permalink to a page. Read More »

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

Returns the relative permalink to a page. Read More »

Creates a baseURL-relative URL. Read More »

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

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

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

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

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

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

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

Creates a sequence of integers. Read More »

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

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

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

Creates a slice (array) of all passed arguments. Read More »

Creates a slice of a half-open range, including start and end indices. Read More »

Sorts maps, arrays, and slices and returns a sorted slice. Read More »

splits a string into substrings separated by a delimiter Read More »

Creates a string from the argument passed to the function Read More »

Returns a slice of a given string with all leading characters contained in the cutset removed. Read More »

Returns a given string s without the provided leading prefix string. If s doesn’t start with prefix, s is returned unchanged. Read More »

Returns a slice of a given string with all trailing characters contained in the cutset removed. Read More »

Returns a given string s without the provided trailing suffix string. If s doesn’t end with suffix, s is returned unchanged. Read More »

Extracts parts of a string from a specified character’s position and returns the specified number of characters. Read More »

Converts a timestamp string into a time.Time structure. Read More »

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

Returns a slice of a passed string with all leading and trailing characters from cutset removed. Read More »

Truncates a text to a max length without cutting words or leaving unclosed HTML tags. Read More »

Given two arrays or slices, returns a new array that contains the elements or objects that belong to either or both arrays/slices. Read More »

Takes in a slice or array and returns a slice with subsequent duplicate elements removed. Read More »

Converts all characters in a string to uppercase Read More »

Takes a string, sanitizes it for usage in URLs, and converts spaces to hyphens. Read More »

Filters an array to only the elements containing a matching value for a given field. Read More »

Rebinds the context (.) within its scope and skips the block if the variable is absent or empty. Read More »