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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_static_i18n-1.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 605e1c3685612df960f58a81e38d31690ac098cfd31c76e4fad00c37359b334e
MD5 5f3250fe6f0aa1b37aef4137100ba00e
BLAKE2b-256 065fcc5bfdd280fdfa623f119ffd9f805d0bb301b3207c06da09d82eeae98c48

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_static_i18n-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0d3e9ea583834143a360f24e35f8a8bed46d47fde4092acce2568ab61b3d12fc
MD5 6ea6b0cce01c13657ed9cd5b4104192b
BLAKE2b-256 4f08c6e83b14089c31a0a797b2e856ff71300861e03531744ec85a32a024f42e

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