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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocs_static_i18n-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6e4a71036fec672dcc4fad80002cd91ea7aa7260240073631ec9bcdfdbcff71a
MD5 3b3682ea1e75dd67b73b16ce6db3bae5
BLAKE2b-256 166d1b35787cc4f1965447bda2d7828637f05bf089da8c98b0430782d03689d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_static_i18n-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b074cbbb6f1e20828506cc148e287b5551957fe3d4f5fb94e81987800dd31bd7
MD5 0c98d1510bc2fc1fcd08a971442afb5e
BLAKE2b-256 7fd38e5f12e21f790ebb184f67d4c4b6e0bebfd77d3fa48596c0729b266dc8c6

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