MkDocs static i18n plugin
An MkDocs plugin that helps you support multiple language versions of your site / documentation.
The mkdocs-static-i18n plugin allows you to support multiple languages of your documentation by adding static translation files to your existing documentation pages.
Multi language support is just one .<language>.md file away!
If you want to see how it looks, check out the demo documentation here.
Language detection logic
This plugin is made to be as simple as possible and will generate a default version of your website + one per configured language on the <language>/ path.
- the
defaultversion will use any.mddocumentation file first and fallback to any.<default_language>.mdfile found - the
/<language>language versions will use any.<language>.mddocumentation file first and fallback to any.<default_language>.mdfile before fallbacking to any default.mdfile found
Since demonstrations are better than words, check out the demo documentation here which showcases the logic.
Installation
Just pip install mkdocs-static-i18n!
Configuration
All the parameters are mandatory:
- default_language: string
- languages: mapping of language name: display value
plugins:
- i18n:
default_language: en
languages:
en: english
fr: français
Example output
Using the configuration above on the following docs/ structure will build the following site/ (leaving out static files for readability):
docs
├── index.fr.md
├── index.md
├── topic1
│ ├── index.en.md
│ └── index.fr.md
└── topic2
├── index.en.md
└── index.md
site
├── en
│ ├── index.html
│ ├── topic1
│ │ └── index.html
│ └── topic2
│ └── index.html
├── fr
│ ├── index.html
│ ├── topic1
│ │ └── index.html
│ └── topic2
│ └── index.html
├── index.html
├── topic1
│ └── index.html
└── topic2
└── index.html
Compatibility with other plugins
This plugin is compatible with the following mkdocs plugins:
- MkDocs Material: the
searchplugin text will be switched automatically to the right language depending on the version you're browsing - MkDocs Awesome Pages Plugin: the page ordering is preserved on the language specific versions of your site
TODO
- add mkdocs-material example with language switcher buttons, meanwhile you can see how it looks on my website.
Contributions welcome!
Feel free to ask questions, enhancements and to contribute to this project!
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file mkdocs-static-i18n-0.3.tar.gz.
File metadata
- Download URL: mkdocs-static-i18n-0.3.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44e238b51d5a50027fd2239d64e072fbdefbfb368c63e3b704ba1ae50c6f1354
|
|
| MD5 |
d2cccb3df61c2a529d69da4819b894b1
|
|
| BLAKE2b-256 |
61328abe35c02f26fbcde5be0724ce92d02264745c31fffe4f7e5c17485d6f33
|
