mirror of
https://github.com/tiennm99/hugoDocs.git
synced 2026-09-15 10:19:11 +00:00
251 lines
8.0 KiB
Markdown
251 lines
8.0 KiB
Markdown
---
|
|
title: Multilingual Mode
|
|
linktitle: Multilingual and i18n
|
|
description: As of v0.17, Hugo supports the creation of websites with multiple languages side by side.
|
|
date: 2017-01-10
|
|
publishdate: 2017-01-10
|
|
lastmod: 2017-01-10
|
|
categories: [content management]
|
|
tags: [multilingual,i18n, internationalization]
|
|
weight: 150
|
|
draft: false
|
|
aliases: [/content/multilingual/,/content-management/multilingual/]
|
|
toc: true
|
|
wip: true
|
|
---
|
|
|
|
Hugo supports multiple languages side-by-side (added in `Hugo 0.17`). Define the available languages in a `Languages` section in your top-level `config.toml` (or equivalent).
|
|
|
|
## Configuring Multilingual Mode
|
|
|
|
The following is an example of a TOML site configuration for a multilingual Hugo project:
|
|
|
|
{{% code file="config.toml" download="config.toml" %}}
|
|
```toml
|
|
DefaultContentLanguage = "en"
|
|
copyright = "Everything is mine"
|
|
|
|
[params.navigation]
|
|
help = "Help"
|
|
|
|
[Languages]
|
|
[Languages.en]
|
|
title = "My blog"
|
|
weight = 1
|
|
[Languages.en.params]
|
|
linkedin = "english-link"
|
|
|
|
[Languages.fr]
|
|
copyright = "Tout est à moi"
|
|
title = "Mon blog"
|
|
weight = 2
|
|
[Languages.fr.params]
|
|
linkedin = "lien-francais"
|
|
[Languages.fr.navigation]
|
|
help = "Aide"
|
|
```
|
|
{{% /code %}}
|
|
|
|
Anything not defined in a `[Languages]` block will fall back to the global
|
|
value for that key (e.g., `copyright` for the English [`en`] language).
|
|
|
|
With the configuration above, all content, sitemap, RSS feeds, paginations,
|
|
and taxonomy pages will be rendered below `/` in English (your default content language) and then below `/fr` in French.
|
|
|
|
When working with front matter `Params` in [single page templates][singles], omit the `params` in the key for the translation.
|
|
|
|
If you want all of the languages to be put below their respective language code, enable `defaultContentLanguageInSubdir: true`.
|
|
|
|
Only the obvious non-global options can be overridden per language. Examples of global options are `BaseURL`, `BuildDrafts`, etc.
|
|
|
|
## Taxonomies and Blackfriday
|
|
|
|
Taxonomies and [Blackfriday configuration][hugoconfig] can also be set per language:
|
|
|
|
```toml
|
|
[Taxonomies]
|
|
tag = "tags"
|
|
|
|
[blackfriday]
|
|
angledQuotes = true
|
|
hrefTargetBlank = true
|
|
|
|
[Languages]
|
|
[Languages.en]
|
|
weight = 1
|
|
title = "English"
|
|
[Languages.en.blackfriday]
|
|
angledQuotes = false
|
|
|
|
[Languages.fr]
|
|
weight = 2
|
|
title = "Français"
|
|
[Languages.fr.Taxonomies]
|
|
plaque = "plaques"
|
|
```
|
|
|
|
## Translating Your Content
|
|
|
|
Translated articles are identified by the name of the content file.
|
|
|
|
### Examples of Translated Articles
|
|
|
|
1. `/content/about.en.md`
|
|
2. `/content/about.fr.md`
|
|
|
|
You can also have:
|
|
|
|
1. `/content/about.md`
|
|
2. `/content/about.fr.md`
|
|
|
|
In which case the config variable `defaultContentLanguage` will be used to affect the default language `about.md`. This way, you can
|
|
slowly start to translate your current content without having to rename everything.
|
|
|
|
If left unspecified, the value for `defaultContentLanguage` defaults to `en`.
|
|
|
|
By having the same _base file name_, the content pieces are linked together as translated pieces.
|
|
|
|
## Link to Translated Content
|
|
|
|
To create a list of links to translated content, use a template similar to this:
|
|
|
|
{{% code file="layouts/partials/i18nlist.html" %}}
|
|
```html
|
|
{{ if .IsTranslated }}
|
|
<h4>{{ i18n "translations" }}</h4>
|
|
<ul>
|
|
{{ range .Translations }}
|
|
<li>
|
|
<a href="{{ .Permalink }}">{{ .Lang }}: {{ .Title }}{{ if .IsPage }} ({{ i18n "wordCount" . }}){{ end }}</a>
|
|
</li>
|
|
{{ end}}
|
|
</ul>
|
|
{{ end }}
|
|
```
|
|
{{% /code %}}
|
|
|
|
The above can be put in a `partial` (`./layouts/partials/`) and included in any template, be it for a [content page][contenttemplate] or the [homepage][]]. It will not print anything if there are no translations for a given page, or if there is---in the case of the homepage, section listing, etc.---a site with only one language.
|
|
|
|
The above also uses the [`i18n` function][i18func] described in the next section.
|
|
|
|
## Translation of Strings
|
|
|
|
Hugo uses [go-i18n](https://github.com/nicksnyder/go-i18n) to support string translations. [See the project's source repository](https://github.com/nicksnyder/go-i18n) to find tools that will help you manage your translation workflows.
|
|
|
|
Translations are collected from the `themes/<THEME>/i18n/` folder (built into the theme), as well as translations present in `i18n/` at the root of your project. In the `i18n`, the translations will be merged and take precedence over what is in the theme folder. Language files should be named according to [RFC 5646][] with names such as `en-US.yaml`, `fr.yaml`, etc.
|
|
|
|
From within your templates, use the `i18n` function like this:
|
|
|
|
```
|
|
{{ i18n "home" }}
|
|
```
|
|
|
|
This uses a definition like this one in `i18n/en-US.yaml`:
|
|
|
|
```
|
|
- id: home
|
|
translation: "Home"
|
|
```
|
|
|
|
Often you will want to use to the page variables in the translations strings. To do that, pass on the "." context when calling `i18n`:
|
|
|
|
```
|
|
{{ i18n "wordCount" . }}
|
|
```
|
|
|
|
This uses a definition like this one in `i18n/en-US.yaml`:
|
|
|
|
```
|
|
- id: wordCount
|
|
translation: "This article has {{ .WordCount }} words."
|
|
```
|
|
An example of singular and plural form:
|
|
|
|
```
|
|
- id: readingTime
|
|
translation:
|
|
one: "One minute read"
|
|
other: "{{.Count}} minutes read"
|
|
```
|
|
And then in the template:
|
|
|
|
```
|
|
{{ i18n "readingTime" .ReadingTime }}
|
|
```
|
|
To track down missing translation strings, run Hugo with the `--i18n-warnings` flag:
|
|
|
|
```bash
|
|
hugo --i18n-warnings | grep i18n
|
|
i18n|MISSING_TRANSLATION|en|wordCount
|
|
```
|
|
|
|
## Menus
|
|
|
|
You can define your menus for each language independently. The [creation of a menu](/content-management/menus/) works analogous to earlier versions of Hugo, except that they have to be defined in their language-specific block in the configuration file:
|
|
|
|
```toml
|
|
defaultContentLanguage = "en"
|
|
|
|
[languages.en]
|
|
weight = 0
|
|
languageName = "English"
|
|
|
|
[[languages.en.menu.main]]
|
|
url = "/"
|
|
name = "Home"
|
|
weight = 0
|
|
|
|
|
|
[languages.de]
|
|
weight = 10
|
|
languageName = "Deutsch"
|
|
|
|
[[languages.de.menu.main]]
|
|
url = "/"
|
|
name = "Startseite"
|
|
weight = 0
|
|
```
|
|
|
|
The rendering of the main navigation works as usual. `.Site.Menus` will just contain the menu of the current language. Pay attention to the generation of the menu links. `absLangURL` takes care that you link to the correct locale of your website. Otherwise, both menu entries would link to the English version because it's the default content language that resides in the root directory.
|
|
|
|
```html
|
|
<ul>
|
|
{{- $currentPage := . -}}
|
|
{{ range .Site.Menus.main -}}
|
|
<li class="{{ if $currentPage.IsMenuCurrent "main" . }}active{{ end }}">
|
|
<a href="{{ .URL | absLangURL }}">{{ .Name }}</a>
|
|
</li>
|
|
{{- end }}
|
|
</ul>
|
|
|
|
```
|
|
|
|
## Missing translations
|
|
|
|
If a string does not have a translation for the current language, Hugo will use the value from the default language. If no default value is set, an empty string will be shown.
|
|
|
|
While translating a Hugo website, it can be handy to have a visual indicator of missing translations. The [`EnableMissingTranslationPlaceholders` configuration option][hugoconfig] will flag all untranslated strings with the placeholder `[i18n] identifier`, where `identifier` is the id of the missing translation.
|
|
|
|
{{% note %}}
|
|
Hugo will generate your website with these placeholders. It might not be suited for production environments.
|
|
{{% /note %}}
|
|
|
|
## Multilingual Themes support
|
|
|
|
To support Multilingual mode in your themes, some considerations must be taken for the URLs in the templates. If there is more than one language, URLs must
|
|
|
|
* Come from the built-in `.Permalink` or `.URL`
|
|
* Be constructed with
|
|
* The [`relLangURL` template function][rellangurl] or the [`absLangURL` template function][abslangurl] template functions **OR**
|
|
* Prefixed with `{{.LanguagePrefix }}`
|
|
|
|
If there is more than one language defined, the`LanguagePrefix` variable will equal `/en` (or whatever your `CurrentLanguage` is). If not enabled, it will be an empty string and is therefore harmless for single-language Hugo websites.
|
|
|
|
[abslangurl]: /functions/abslangurl
|
|
[contenttemplate]: /templates/single-page-template/
|
|
[homepage]: /templates/homepage/
|
|
[hugoconfig]: /getting-started/configuration/
|
|
[i18func]: /functions/i18n/
|
|
[RFC 5646]: https://tools.ietf.org/html/rfc5646
|
|
[singles]: /templates/single-page-templates/
|
|
[rellangurl]: /functions/rellangurl |