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

Added slug function reference to language configuration guide

Browse Source
This commit is contained in:
squidfunk 2020-09-06 13:35:18 +02:00
parent 905af43634
commit b2e8423232
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -76,26 +76,30 @@ The following languages are supported:
</li>
</ul>
_Note that some languages will produce unreadable anchor links, due to the way
the default slug function works. Consider using a Unicode-aware slug function,
as [documented here][2]._
[1]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/language/en.html
[2]: http://localhost:8000/setup/setting-up-navigation/#slugify
### Site search language
[:octicons-file-code-24: Source][2] ·
[:octicons-file-code-24: Source][3] ·
: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
work properly. Material for MkDocs relies on [lunr-languages][4] to provide this
functionality. See the guide detailing how to [set up site search][5] 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
[3]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/javascripts/integrations/search/worker/main/index.ts#L49-L69
[4]: https://github.com/MihaiValentin/lunr-languages
[5]: setting-up-site-search.md
### Directionality
[:octicons-file-code-24: Source][5] ·
[:octicons-file-code-24: Source][6] ·
:octicons-milestone-24: Default: _automatically set_
While many languages are read `ltr` (left-to-right), Material for MkDocs also
@ -127,7 +131,7 @@ directionality:
})
</script>
[5]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html#L168
[6]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html#L168
## Customization
@ -137,7 +141,7 @@ directionality:
: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
you may follow the guide on [theme extension][7] 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.
@ -156,4 +160,4 @@ theme:
language: en-custom
```
[6]: ../customization.md#extending-the-theme
[7]: ../customization.md#extending-the-theme