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.1.1.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

mkdocs_static_i18n-1.1.1-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_static_i18n-1.1.1.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.25.0

File hashes

Hashes for mkdocs_static_i18n-1.1.1.tar.gz
Algorithm Hash digest
SHA256 1c0820f12a0fb51becf0d65a326eb3b6046e4a03393c0fa050f8d7d6ddf02027
MD5 911404025cd3ac45c13e2761c5f5768b
BLAKE2b-256 559302894395ce245c5443a711f787675fa275f96c4df6d9c5c9dbda9b594110

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_static_i18n-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 942668ed17067f8f0b17a1d940722b683a33e0d72f45c70c15dad1d49b076261
MD5 e395695d346f3db5d0ab45d17e06e0f9
BLAKE2b-256 8c28fcab68b2ed74f45f372dc505af0b09b01a3dd516a763fd7a4bef5b65b099

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