HUGO
Menu
GitHub 90529 stars Mastodon

Rotate

Returns a collection of pages that vary along the specified dimension while sharing the current page’s values for the other dimensions, including the current page, sorted by the dimension’s default sort order.
Syntax
PAGE.Rotate DIMENSION
Returns
page.Pages
New in v0.153.0

Usage

The Rotate method on a Page object returns a collection of pages that vary along the specified dimension of the multidimensional content model, while holding the other dimensions constant. The result includes the current page and is sorted according to the rules of the specified dimension. For example, rotating along language returns all language variants that share the current page’s version and role. The collection includes only the sites that the page is published to.

Hugo sorts the collection using these rules:

DimensionPrimary sortSecondary sort
LanguageWeight ascendingLexicographical ascending
VersionWeight ascendingSemantic version descending
RoleWeight ascendingLexicographical ascending

Arguments

DIMENSION
(string) The dimension to rotate along, one of language, version, or role.

Examples

{{/* Returns languages sorted by weight ascending, then lexicographically ascending */}}
{{ range .Rotate "language" }}
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
{{ end }}

Rotating along the version dimension:

{{/* Returns versions sorted by weight ascending, then semantic version descending */}}
{{ range .Rotate "version" }}
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
{{ end }}

Rotating along the role dimension:

{{/* Returns roles sorted by weight ascending, then lexicographically ascending */}}
{{ range .Rotate "role" }}
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
{{ end }}