About mkdocs-static-i18n

MkDocs i18n plugin using static translation markdown files

u

Published by

ultrabug

Visit View Profile

README.md

View on GitHub

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.

:warning: Due to the core MkDocs upstream being unmaintained and uncertain this project is frozen as-is.

You can find a more detailed explanation of the situation here, especially if you're interested in Zensical's plans about i18n support.

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.

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!

Development

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

Credits

Logo by max.icons

mkdocs-static-i18n