A mkdocs plugin to add relative paths to Google Translate queries
Install using pip install mkdocs-google-translate
Activate the plugin in mkdocs.yml
by adding the following lines, replace the values of _x_tr_sl
and _x_tr_tl
to match your site:
extra:
alternate:
# Original Language
- name: English
lang: 'en'
link: '%GT_RELATIVE_URL%' # For relative urls back to original language
# Extra languages
- name: Norsk
lang: 'no'
link: 'https://translate.goog/?_x_tr_sl=en&_x_tr_tl=no'
# _x_tr_sl = source language
# _x_tr_tl = translation language
plugins:
- search
- google-translate:
url: example.com # optional (required for local testing)
Note: If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set, but now you have to enable it explicitly.
This plugin is somewhat incompatible with the mkdocs feature navigation.instant
, due to the fact that the page heading never changes with the feature enabled.