github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/methods/site/Language.md
Bjørn Erik Pedersen 5fd1e74903
Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs' 
```
git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash
```

Closes #11925
2024-01-27 10:48:57 +01:00

2.1 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.
{{ .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="{{ or site.Language.LanguageCode site.Language.Lang }}" 
  dir="{{ or site.Language.LanguageDirection `ltr` }}
>

The example above uses the global site function instead of accessing the Site object via the .Site notation.

Also note that each attribute has a fallback value assigned via the or operator.