github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-01 17:50:49 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/methods/site/Language.md
Bjørn Erik Pedersen af0cb57aaf
Merge commit '8b9803425e63e1b1801f8d5d676e96368d706722'
2024-06-21 09:41:24 +02:00

1.9 KiB
Raw Blame History

title description categories keywords action toc
Language Returns the language object for the given site.
related returnType signatures
methods/page/language
langs.Language
SITE.Language
true

The Language method on a Site object returns the language object for the given site. The language object points to the language definition in the site configuration.

You can also use the Language method on a Page object. See details.

Methods

The examples below assume the following in your site configuration:

{{< code-toggle file=hugo >}} [languages.de] languageCode = 'de-DE' languageDirection = 'ltr' languageName = 'Deutsch' weight = 1 {{< /code-toggle >}}

Lang
(string) The language tag as defined by RFC 5646.
{{ .Site.Language.Lang }} → de
LanguageCode
(string) The language code from the site configuration. Falls back to Lang if not defined.
{{ .Site.Language.LanguageCode }} → de-DE
LanguageDirection
(string) The language direction from the site configuration, either ltr or rtl.
{{ .Site.Language.LanguageDirection }} → ltr
LanguageName
(string) The language name from the site configuration.
{{ .Site.Language.LanguageName }} → Deutsch
Weight
(int) The language weight from the site configuration which determines its order in the slice of languages returned by the Languages method on a Site object.
{{ .Site.Language.Weight }} → 1

Example

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` }}
>