Languages and detection
| Option | Default | Meaning |
|---|---|---|
languages | ["en"] | The site’s languages. A string is a code, an object see below. |
defaultLanguage | first language | For pages with no detection match |
detection | folder, suffix, frontmatter | Detection ways in order of precedence. [] assigns everything to the default language. |
linking | frontmatter, aliases, path | Linking ways in order of precedence |
frontmatterKeys | lang, translationKey, translations | Which fields are read |
A language entry:
| Field | Default | Meaning |
|---|---|---|
code | required | In folders, suffixes, frontmatter — de |
label | code in capitals | Display name — German |
native | label | Name in the language itself — Deutsch |
locale | code | For <html lang>, hreflang, og:locale — de-DE |
home | <code>/index | Slug of the language start page |
flag | flag of the locale’s region | For switcher.style: flags |
Switcher
| Option | Default | Meaning |
|---|---|---|
switcher.style | links | links, dropdown, flags |
switcher.label | label | code, label, native, translatedTitle |
switcher.showCurrent | true | Current language as an entry without a link |
switcher.missing | home | hide, home, disabled |
switcher.separator | | | Separator in the links style |
switcher.title | translated “Language” | Accessible name |
Addresses, redirects, notices
| Option | Default | Meaning |
|---|---|---|
seo.hreflang | true | hreflang links. Needs baseUrl. |
seo.ogLocale | true | og:locale and og:locale:alternate |
seo.xDefault | default | default, none or a language code |
rootRedirect | none | none, default, browser |
rememberChoice | true | Remember the chosen language |
fallbackPages | none | none or redirect |
missingTranslationNotice | false | “only available in …” |
availableTranslationNotice | false | “also available in …” |
rewriteCrossLanguageLinks | false | Needs order above 60 |
localizeDates | false | <time> in the page’s language |
publishLanguages | [] (all) | Build only these languages |
Explained in chapter 2 (detection), 3 (linking), 4 (switcher), 5 (addresses), 6 (redirects), 7 (notices) and 8 (building).