--- 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][1] · :octicons-milestone-24: Default: `en` You can set the _site language_ in `mkdocs.yml` with: ``` yaml theme: language: en ``` The following languages are supported: [1]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/language/en.html ### Site search language [:octicons-file-code-24: Source][2] · :octicons-milestone-24: Default: _automatically set_ Some languages, like Arabic or Japanese, need dedicated stemmers for search to work properly. Material for MkDocs relies on [lunr-languages][3] to provide this functionality. See the guide detailing how to [set up site search][4] for more information. [2]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/javascripts/integrations/search/worker/main/index.ts#L49-L69 [3]: https://github.com/MihaiValentin/lunr-languages [4]: setting-up-site-search.md ### Directionality [:octicons-file-code-24: Source][5] · :octicons-milestone-24: Default: _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: ``` yaml theme: direction: ltr ``` :material-cursor-default-click-outline: click on a tile to change the directionality:
[5]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html#L168 ## Customization ### Custom translations [:octicons-file-code-24: Source][1] · :octicons-mortar-board-24: Difficulty: _easy_ If you want to customize some (or all) of the translations for your language, you may follow the guide on [theme extension][6] and create a new partial in `partials/language`, e.g. `en-custom.html`. Next, look up the translation you want to change in the [base translation][1] and add it to the partial. Let's say you want to change "__Table of contents__" to "__On this page__": ``` jinja {% macro t(key) %}{{ { "toc.title": "On this page" }[key] }}{% endmacro %} ``` Then, add the following lines to `mkdocs.yml`: ``` yaml theme: language: en-custom ``` [6]: ../customization.md#extending-the-theme