mkdocs-material/docs/guides/changing-the-language.md

template

template
overrides/main.html

Changing the language

Material for MkDocs supports internationalization (i18n) and provides translations for template variables and labels in 40+ languages. Additionally, search can be configured to use a language-specific stemmer (if available).

Configuration

Site language

:octicons-file-code-24: Source · :octicons-tools-24: Default: en

You can set the language from mkdocs.yml with:

theme:
  language: en

The following languages are supported:

<style> .md-language-list { -webkit-columns: 2; -moz-columns: 2; columns: 2; } .md-language-list li { -webkit-column-break-inside: avoid; page-break-inside: avoid; break-inside: avoid; } </style>

• af / Afrikaans
• ar / Arabic
• bn / Bengali (Bangla)
• ca / Catalan
• cs / Czech
• da / Danish
• de / German
• en / English
• es / Spanish
• et / Estonian
• fa / Persian (Farsi)
• fi / Finnish
• fr / French
• gl / Galician
• gr / Greek
• he / Hebrew
• hi / Hindi
• hr / Croatian
• hu / Hungarian
• id / Indonesian
• it / Italian
• ja / Japanese
• kr / Korean
• my / Burmese
• nl / Dutch
• nn / Norwegian (Nynorsk)
• no / Norwegian
• pl / Polish
• pt / Portuguese
• ro / Romanian
• ru / Russian
• sh / Serbo-Croatian
• si / Slovenian
• sk / Slovak
• sr / Serbian
• sv / Swedish
• th / Thai
• tr / Turkish
• uk / Ukrainian
• vi / Vietnamese
• zh / Chinese (Simplified)
• zh-Hant / Chinese (Traditional)
• zh-TW / Chinese (Taiwanese)
• Add language

Site search

:octicons-file-code-24: Source · :octicons-tools-24: Default: best match for theme.language, automatically set

Some languages, like Arabic or Japanese, need dedicated stemmers for search to work properly. Material for MkDocs relies on lunr-languages to provide this functionality. See the search plugin documentation for more information.

Directionality

:octicons-file-code-24: Source · :octicons-tools-24: Default: best match for theme.language, automatically set

While many languages are read ltr (left-to-right), Material for MkDocs also supports rtl (right-to-left) directionality which is inferred from the selected language, but can also be set with:

theme:
  direction: ltr

:material-cursor-default-click-outline: click on a tile to change the directionality:

<style> .md-typeset button[data-md-dir] { cursor: pointer; transition: opacity 250ms; } .md-typeset button[data-md-dir]:hover { opacity: 0.75; } .md-typeset button[data-md-dir] > code { display: block; color: var(--md-primary-bg-color); background-color: var(--md-primary-fg-color); } </style>

ltr rtl

<script> var buttons = document.querySelectorAll("button[data-md-dir]") buttons.forEach(function(button) { button.addEventListener("click", function() { var attr = this.getAttribute("data-md-dir") document.body.dir = attr var name = document.querySelector("#__code_1 code span:nth-child(5)") name.textContent = attr }) }) </script>