MkDocs i18n plugin
A plugin to internationalize MkDocs. It adds links to translated pages for each page. It also hides other languages page links of navigation menu if there is a translation for current page language.
Example of mkdocs-18n usage: https://mkdocs-i18n.gitlab.io/mkdocs-i18n
Feel free to write your comments or request adaptations to your requirements at https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/issues.
Case Studies
http://isardvdi.com (https://isard.gitlab.io/isardvdi-docs) is a multilingual community, most members know 2 languages but not the same ones, some understand 3... Each one has its favorite language and has different levels of knowledge about other languages. In addition, community documentation doesn't have a source language and not all documents need to be translated into all languages. Therefore, this plugin shows all available translations for the page shown at the top of the document and also for pages not translated into the language selected in the navigation menu.
Setup
Install the plugin using pip:
pip install mkdocs-i18n
Configure the plugin via mkdocs.yml
If you have no plugins entry in your configuration file you have search plugin enabled. If you create plugins entry to enable i18n plugin you also need to add search plugin if you want to have search plugin enabled.
Donations:
Other interesting works:
- MkDocs static i18n plugin: Builds a parallel structure of translated documents with a source language. It does not link to other translations of the current document and does not show pages that have not been translated into the current language or the default language. Therefore, documents translated only into a non-default language are only linked to the navigation menu when visiting a page with the same language.
- MkDocs Theme i18n: Work in progress.
- Markdown i18n plugin: Provide translation of documents via po files but images cannot be localized.
- MkDocs Multilang: Only released for MkDocs < 1.0
- Site language selector of Material for MkDocs: Do you know what it does?
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-i18n 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| mkdocs-i18n-0.2.1.tar.gz | 5.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_i18n-0.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.2 kB
Release files / mkdocs-i18n-0.2.1.tar.gz
| Download URL | mkdocs-i18n-0.2.1.tar.gz |
|---|---|
| Size | 5.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
46bfea0d7decfdf5527564659f0128998632de86eb2a9cc09e84d72a23a98635
|
|
BLAKE2b-256 checksum How to use checksums |
ba5d5f8b4dd87165bb885a1db554d20dc3f53f0dd2b54f16178b3b5ae1086092
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1
|
Release files / mkdocs_i18n-0.2.1-py3-none-any.whl
| Download URL | mkdocs_i18n-0.2.1-py3-none-any.whl |
|---|---|
| Size | 17.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8eadc5e952f9780f80a29eca415a3ac6ce004a139647b33302356717bc0e2acc
|
|
BLAKE2b-256 checksum How to use checksums |
171702596e77ad40ddb2c4b40c7d96e88d01cfe90154e54a0eb6873c4cd7fa00
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1
|
Security for mkdocs-i18n 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
