5 Commits

Author SHA1 Message Date
Waylan Limberg
769a926691 Correct documentation of on_pre_template event.
The behavior of this event has never changed. The documentation was simply
incorrect. Fixes #2308.
2021-06-02 13:01:21 -04:00
Álvaro Mondéjar
a8ec4b64a3 Add 'es' themes translations
Document that, when a new translation is added for a theme, the documentation about the theme must be updated.
2021-05-07 09:57:19 -04:00
Ultrabug
e1b77ab66e Support theme localization
A framework for translating themes as been added, which includes:

1. Use of Jinja's `i18n` plugin for translating phrases in templates (not page content).
2. A French translation of the built-in themes (contributions in other languages are welcome).
3. A new `theme.locale` option to define the locale/language of the site.
4. The search plugin uses the value of `theme.locale` as its default 'lang'.
5. Third party themes may chose to use the framework (use is optional).
6. A documented workflow for translating MkDocs built-in themes.
7. Custom tooling for use by translators and theme devs.

The dependencies are not installed by default and are not needed to use MkDocs without translations. However, for anyone who wants to make use of the features, `pip install mkdocs[i18n]` will install all necessary dependencies.

Relates to #211.
2021-05-06 14:30:21 -04:00
Waylan Limberg
6218e524b5 Correct docs if page template context var
Fixes #1736.
2021-04-10 19:31:14 -04:00
Waylan Limberg
a118183f5e Refactor docs (#2344)
The homepage has been redesigned. The "Installation" and "Getting Started" sections were moved to their own respective pages. Then, the homepage was restyled so that the list of features appear as a grid of cards.

The developer specific pages were moved to a new section: `dev-guide`. Any old URLs redirect to the new ones.
2021-04-04 16:14:29 -04:00