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 hashes)

Uploaded source

Built Distribution

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

Uploaded py3

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