HUGO
News Docs Themes Community GitHub

Dimension

Returns the dimension object for the given dimension for the given site.

Syntax

SITE.Dimension DIMENSION

Returns

page.SiteDimension
New in v0.153.0

The Dimension method on a Site object returns the dimension object for the given dimension.

The DIMENSION argument must be one of language, role, or version.

ExampleReturnsEquivalent to
.Site.Dimension "language"langs.Language.Site.Language
.Site.Dimension "role"roles.Role.Site.Role
.Site.Dimension "version"version.Version.Site.Version
{{ $languageObject := .Site.Dimension "language" }}
{{ $languageObject.IsDefault }} → true
{{ $languageObject.Name }} → en

{{ $roleObject := .Site.Dimension "role" }}
{{ $roleObject.IsDefault }} → true
{{ $roleObject.Name }} → guest

{{ $versionObject := .Site.Dimension "version" }}
{{ $versionObject.IsDefault }} → true
{{ $versionObject.Name }} → v1.0.0z