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

Uploaded Source

Built Distribution

mkdocs_static_i18n-1.0.5-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocs_static_i18n-1.0.5.tar.gz
Algorithm Hash digest
SHA256 1342990b0bcdc8da3338a418089b6890f5ee49b3efd8297885b87734567c00c5
MD5 26224d5814c97bb179cf56ca2b3d6639
BLAKE2b-256 4d5e6501b985f44aa9e99e226bb718acd129f519279c579d64c83b52ee6435e1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_static_i18n-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 554813ee28fe4b1ce07dea4399b6a26eddf137ed00dac10dc2988d472ebc4e60
MD5 861cccaae8d79ddf6a5dd3740c644be1
BLAKE2b-256 76b725ac9a42fec57e9dd6115ad8902f5bdb34078d1a7a13c45d9a18cea58167

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