The MkDocs plugin that helps you support multiple language versions of your site / documentation.
Like what you 👀? Using this plugin? Give it a ⭐!
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!
Check out the plugins' documentation here.
TL;DR? There's a quick start guide for you!
mkdocs.yml
file!
This plugin is proudly bringing localized content of hundreds of projects to their users.
Check it out live:
But also in our hall of fame:
- AWS Copilot CLI
- OWASP Top 10
- Spaceship Prompt
- FederatedAI FATE
- Privacy Guides Org
- Computer Science Self Learning Wiki
Feel free to ask questions, enhancements and to contribute to this project!
The project is managed with hatch
. Install hatch
first.
Run the tests:
hatch run test:test
hatch run style:check
Serve the documentation:
hatch run doc:serve
- Logo by max.icons