Skip to main content

MkDocs i18n plugin

Project description

MkDocs i18n plugin

A plugin to internationalize MkDocs. It adds links to translated pages for each page. It also hides other languages page links of navigation menu if there is a translation for current page language.

Example of mkdocs-i18n usage: https://mkdocs-i18n.gitlab.io/mkdocs-i18n

Feel free to write your comments or request adaptations to your requirements at https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/issues.

mkdocs-i18n updates Site Language of Material for MkDocs if it is enabled.

mkdocs-i18n updates Site Language Selector of Material for MkDocs linking each translated page if it is configured.

Case Studies

http://isardvdi.com (https://isard.gitlab.io/isardvdi-docs) is a multilingual community, most members know 2 languages but not the same ones, some understand 3... Each one has its favorite language and has different levels of knowledge about other languages. In addition, community documentation doesn't have a source language and not all documents need to be translated into all languages. Therefore, this plugin shows all available translations for the page shown at the top of the document and also for pages not translated into the language selected in the navigation menu.

Setup

Install the plugin using pip:

pip install mkdocs-i18n

Configure the plugin via mkdocs.yml

If you have no plugins entry in your configuration file you have search plugin enabled. If you create plugins entry to enable i18n plugin you also need to add search plugin if you want to have search plugin enabled.

Donations:

Other interesting works:

  • MkDocs static i18n plugin: Builds a parallel structure of translated documents with a source language. It does not link to other translations of the current document and does not show pages that have not been translated into the current language or the default language. Therefore, documents translated only into a non-default language are only linked to the navigation menu when visiting a page with the same language.
  • MkDocs Theme i18n: Work in progress.
  • Markdown i18n plugin: Provide translation of documents via po files but images cannot be localized.
  • MkDocs Multilang: Only released for MkDocs < 1.0

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-i18n-0.4.6.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

mkdocs_i18n-0.4.6-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs-i18n-0.4.6.tar.gz.

File metadata

  • Download URL: mkdocs-i18n-0.4.6.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.29.0 requests-toolbelt/0.10.1 urllib3/1.26.15 tqdm/4.65.0 importlib-metadata/6.6.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.16

File hashes

Hashes for mkdocs-i18n-0.4.6.tar.gz
Algorithm Hash digest
SHA256 977736ac643e6a9fece2f331c72168dda298b09ed55049a9c3bb6be33e099af0
MD5 dea724fd4d4424867cc2054b3fe4efae
BLAKE2b-256 6b316aad3256057551b1b8b2c8447a3669bfb3c1f99f833280e167b8fedd1d97

See more details on using hashes here.

File details

Details for the file mkdocs_i18n-0.4.6-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_i18n-0.4.6-py3-none-any.whl
  • Upload date:
  • Size: 17.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.29.0 requests-toolbelt/0.10.1 urllib3/1.26.15 tqdm/4.65.0 importlib-metadata/6.6.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.16

File hashes

Hashes for mkdocs_i18n-0.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 44054cd7de6150f8e03aa074fc46d9ea661e660c9df0aab802115dd30636bc08
MD5 8f8e9bba26496c0a0ebf1e0f04414d4e
BLAKE2b-256 40d09523dcdfaa9f6968a85e967225213e9ea79e046e8da65282af56e8dbd4c1

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page