Language
Syntax
Returns
The Language method on a Site object returns the Language object for the given site, derived from the language definition in your project configuration.
You can also use the Language method on a Page object. See details.
Methods
The examples below assume the following in your project configuration:
languages:
de:
languageCode: de-DE
languageDirection: ltr
languageName: Deutsch
weight: 1
[languages]
[languages.de]
languageCode = 'de-DE'
languageDirection = 'ltr'
languageName = 'Deutsch'
weight = 1
{
"languages": {
"de": {
"languageCode": "de-DE",
"languageDirection": "ltr",
"languageName": "Deutsch",
"weight": 1
}
}
}
IsDefault
New in v0.153.0(bool) Reports whether this is the default language.
{{ .Site.Language.IsDefault }} → trueLang
(string) Returns the language tag as defined by RFC 5646. This is the lowercased key from your project configuration.
{{ .Site.Language.Lang }} → deLanguageCode
(string) Returns the languageCode from your project configuration. Falls back to Lang if not defined.
{{ .Site.Language.LanguageCode }} → de-DELanguageDirection
(string) Returns the languageDirection from your project configuration.
{{ .Site.Language.LanguageDirection }} → ltrLanguageName
(string) Returns the languageName from your project configuration.
{{ .Site.Language.LanguageName }} → DeutschName
New in v0.153.0(string) Returns the language tag as defined by RFC 5646. This is the lowercased key from your project configuration. This is an alias for Lang.
{{ .Site.Language.Name }} → deWeight
(int) Returns the language weight from your project configuration.
{{ .Site.Language.Weight }} → 1Example
Some of the methods above are commonly used in a base template as attributes for the html element.
<html
lang="{{ .Site.Language.LanguageCode }}"
dir="{{ or .Site.Language.LanguageDirection `ltr` }}"
>