OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation for language overrides

Browse Source 
docs: clarify overriding of translations for non-English language
This commit is contained in:
Martin Donath 2021-09-20 18:51:07 +02:00 committed by GitHub
commit 8fa40faf3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/setup/changing-the-language.md
View File

@ -178,7 +178,7 @@ Click on a tile to change the directionality:
[:octicons-file-code-24: Source][1] · [:octicons-file-code-24: Source][1] ·
:octicons-mortar-board-24: Difficulty: _easy_ :octicons-mortar-board-24: Difficulty: _easy_
If you want to customize some of the translations for your language, just follow If you want to customize some of the translations for a language, just follow
the guide on [theme extension][9] and create a new partial in the guide on [theme extension][9] and create a new partial in
`partials/languages`, e.g. `en-custom.html`. Next, look up the translation you `partials/languages`, 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. want to change in the [base translation][1] and add it to the partial.
@ -186,9 +186,14 @@ 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__": Let's say you want to change "__Table of contents__" to "__On this page__":
``` html ``` html
{% macro t(key) %}{{ { <!-- Use en language as fallback -->
{% import "partials/languages/en.html" as fallback %}
{% macro override(key) %}{{ {
"toc.title": "On this page" "toc.title": "On this page"
}[key] }}{% endmacro %} }[key] }}{% endmacro %}
<!-- Re-export the translation macro for mkbuild-material to use -->
{% macro t(key) %}{{ override(key) or fallback.t(key) }}{% endmacro %}
``` ```
Then, add the following lines to `mkdocs.yml`: Then, add the following lines to `mkdocs.yml`: