Skip to main content

MkDocs i18n plugin using static translation markdown files

Project description

logo by max.icons

MkDocs static i18n plugin

mkdocs-static-i18n pypi version

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!

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 to ease updating your mkdocs.yml file!

See it in action

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:

Contributions welcome

Feel free to ask questions, enhancements and to contribute to this project!


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_static_i18n-1.2.3.tar.gz (1.4 MB view hashes)

Uploaded Source

Built Distribution

mkdocs_static_i18n-1.2.3-py3-none-any.whl (21.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page