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

Uploaded Source

Built Distribution

mkdocs_static_i18n-1.2.3-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocs_static_i18n-1.2.3.tar.gz
Algorithm Hash digest
SHA256 7ccf4da6dd29570ec49cd863ebff6fef9cb82dbb1cb85249bdf744e8d839c914
MD5 a5576259d6404d6111822a9ef60a6f00
BLAKE2b-256 7e39e8c24a79d7fd557be67967e2bed3fd450247182ef01d3408a6b3193903c3

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for mkdocs_static_i18n-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e6f2f3c53b657d7632015b32dea3c64d0b80a7a8d6cde0334ca8f66f9e33b52f
MD5 13e73f29a012b59c81f51c350f9110af
BLAKE2b-256 3a194c9f865302cd773c30fc14ed1b1a15074a7f3132caf4543c77e57c22885f

See more details on using hashes here.

Provenance

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