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!

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!

Credits

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.0.3.tar.gz (941.6 kB view details)

Uploaded Source

Built Distribution

mkdocs_static_i18n-1.0.3-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_static_i18n-1.0.3.tar.gz.

File metadata

  • Download URL: mkdocs_static_i18n-1.0.3.tar.gz
  • Upload date:
  • Size: 941.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.24.1

File hashes

Hashes for mkdocs_static_i18n-1.0.3.tar.gz
Algorithm Hash digest
SHA256 c46615a01d5a099befd1b68d4c5f5988a7001efbc318825ba0a3e46a6624e403
MD5 ea478fd1b22a61ac22b0033bd2f73e50
BLAKE2b-256 33a7252ac2d38e3d145b4d7056bcde161702f0e12b9edcaae877b95eeeab6d15

See more details on using hashes here.

File details

Details for the file mkdocs_static_i18n-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_static_i18n-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5d0ad406c9a2ae40ebfccd6f23e01362214ad50b3f595281fe0763b273f2500c
MD5 647994ccd9078b7524dd9359d53ca0eb
BLAKE2b-256 39ab394ffb262282aaa304a502e1288ef3e627ca44cfd601814d342d978dbd6c

See more details on using hashes here.

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