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!
Check out the plugins' documentation here.
TL;DR? There's a quick start guide for you!
:warning: Version 1.0.0 brings breaking changes to the configuration format of the plugin. Check out the upgrade to v1.0.0 guide to ease updating your 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:
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
FAQs
MkDocs i18n plugin using static translation markdown files
We found that mkdocs-static-i18n demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.