Skip to content
Snippets Groups Projects
Commit d849199d authored by Nicolas Mounet's avatar Nicolas Mounet
Browse files

Update mkdocs_site.md

parent 101d744b
No related branches found
No related tags found
No related merge requests found
Pipeline #4569096 passed
...@@ -73,6 +73,14 @@ If you are using the multi-language package i18n (as in the example provided on ...@@ -73,6 +73,14 @@ If you are using the multi-language package i18n (as in the example provided on
pip install mkdocs-static-i18n pip install mkdocs-static-i18n
``` ```
**Tip**: make sure you use locally the same versions as those used internally by CERN infrastructure, which can be checked [here](https://gitlab.cern.ch/authoring/documentation/mkdocs-ci/-/blob/master/mkdocs-gitlab-pages.gitlab-ci.yml#L12). Conversely, you may also change the versions used by your website, by adding to `.gitlab-ci.yml` in your gitlab repo, some lines of the form (but keep in mind that then CERN will not provide any support):
```
variables:
MKDOCS_VERSION: 'X.X.X'
MATERIAL_VERSION: 'Y.Y.Y'
I18NSTATIC_VERSION: 'Z.Z'
```
**Tip**: if you want to use `mkdocs-i18n` instead (which seems indeed better than `mkdocs-static-i18n`), to get the contents on the left translated properly, you will need to modify `mkdocs.yml` given in https://gitlab.cern.ch/authoring/documentation/mkdocs-container-example.git, replacing `nav_translations` by `translate_nav` (see [example](https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/blob/main/mkdocs.yml)). But up to now (Sept. 2022), the CERN infrastructure does not seem to support it anyway... **Tip**: if you want to use `mkdocs-i18n` instead (which seems indeed better than `mkdocs-static-i18n`), to get the contents on the left translated properly, you will need to modify `mkdocs.yml` given in https://gitlab.cern.ch/authoring/documentation/mkdocs-container-example.git, replacing `nav_translations` by `translate_nav` (see [example](https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/blob/main/mkdocs.yml)). But up to now (Sept. 2022), the CERN infrastructure does not seem to support it anyway...
#### Compile your website #### Compile your website
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment