1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
# MkDocs static i18n plugin
*The MkDocs plugin that helps you support multiple language versions of your site / documentation.*
*Like what you :eyes:? Using this plugin? Give it a :star:!*
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**!
Even better, `mkdocs-static-i18n` also allows you to build and serve localized versions of any file extension to display localized images, medias and assets.
Localized images/medias/assets are just **one `.<language>.<extension>` file away**!
Don't like file suffixes? You're more into a folder based structure? We got you covered as well!
## Documentation
Check out the [plugins' documentation here](https://ultrabug.github.io/mkdocs-static-i18n/).
TL;DR? There's a [quick start guide](https://ultrabug.github.io/mkdocs-static-i18n/getting-started/quick-start/) for you!
## Upgrading from 0.x versions
:warning: Version 1.0.0 brings **breaking changes** to the configuration format of the plugin. Check out the [upgrade to v1.0.0 guide](https://ultrabug.github.io/mkdocs-static-i18n/setup/upgrading-to-1/) to ease updating your `mkdocs.yml` file!
## See it in action
This plugin is proudly bringing localized content of [hundreds of projects](https://github.com/ultrabug/mkdocs-static-i18n/network/dependents) to their users.
Check it out live:
- [On this repository documentation](https://ultrabug.github.io/mkdocs-static-i18n/)
- [On my own website: ultrabug.fr](https://ultrabug.fr)
But also in our hall of fame:
- [AWS Copilot CLI](https://aws.github.io/copilot-cli/)
- [OWASP Top 10](https://github.com/OWASP/Top10)
- [Spaceship Prompt](https://spaceship-prompt.sh/)
- [FederatedAI FATE](https://fate.readthedocs.io/en/latest/)
- [Privacy Guides Org](https://www.privacyguides.org/en/)
- [Computer Science Self Learning Wiki](https://csdiy.wiki/)
## Contributions welcome
Feel free to ask questions, enhancements and to contribute to this project!
## Development
The project is managed with `hatch`. [Install `hatch`](https://hatch.pypa.io/1.9/install/#gui-installer) first.
Run the tests:
```
hatch run test:test
hatch run style:check
```
Serve the documentation:
```
hatch run doc:serve
```
## Credits
- Logo by [max.icons](https://www.flaticon.com/authors/maxicons)
|
