| Name | mkdocs-i18n JSON |
| Version |
0.4.6
JSON |
| download |
| home_page | |
| Summary | MkDocs i18n plugin |
| upload_time | 2023-04-27 11:48:09 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | <4,>=3.7 |
| license | AGPL-3.0-or-later |
| keywords |
mkdocs
plugin
i18n
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language) if [it is enabled](https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/blob/main/mkdocs.yml#L7).
mkdocs-i18n updates [Site Language Selector of Material for MkDocs](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector) linking each translated page if [it is configured](https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/blob/main/mkdocs.yml#L57).
## 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](https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/blob/main/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:
- [Liberapay](https://liberapay.com/mkdocs-i18n/donate)
- [Bitcoin](bitcoin:15QqofyoWxDSZU9VbXwVZKFxAVdmpkE5uH?message=mkdocs-i18n)
## Other interesting works:
- [MkDocs static i18n plugin](https://github.com/ultrabug/mkdocs-static-i18n): 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](https://github.com/mkdocs/mkdocs/pull/2299): Work in progress.
- [Markdown i18n plugin](https://github.com/gisce/markdown-i18n): Provide translation of documents via po files but images cannot be localized.
- [MkDocs Multilang](https://pypi.org/project/mkdocs-multilang/): Only released for MkDocs < 1.0
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-i18n",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.7",
"maintainer_email": "",
"keywords": "mkdocs,plugin,i18n",
"author": "",
"author_email": "Sim\u00f3 Albert i Beltran <sim6@bona.gent>",
"download_url": "https://files.pythonhosted.org/packages/6b/31/6aad3256057551b1b8b2c8447a3669bfb3c1f99f833280e167b8fedd1d97/mkdocs-i18n-0.4.6.tar.gz",
"platform": null,
"description": "# MkDocs i18n plugin\n\nA 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.\n\nExample of mkdocs-i18n usage: <https://mkdocs-i18n.gitlab.io/mkdocs-i18n>\n\nFeel free to write your comments or request adaptations to your requirements at <https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/issues>.\n\nmkdocs-i18n updates [Site Language of Material for MkDocs](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language) if [it is enabled](https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/blob/main/mkdocs.yml#L7).\n\nmkdocs-i18n updates [Site Language Selector of Material for MkDocs](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector) linking each translated page if [it is configured](https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/blob/main/mkdocs.yml#L57).\n\n## Case Studies\n\n<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.\n\n## Setup\n\nInstall the plugin using pip:\n\n`pip install mkdocs-i18n`\n\nConfigure the plugin via [mkdocs.yml](https://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/blob/main/mkdocs.yml)\n\nIf 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.\n\n## Donations:\n\n- [Liberapay](https://liberapay.com/mkdocs-i18n/donate)\n- [Bitcoin](bitcoin:15QqofyoWxDSZU9VbXwVZKFxAVdmpkE5uH?message=mkdocs-i18n)\n\n## Other interesting works:\n\n- [MkDocs static i18n plugin](https://github.com/ultrabug/mkdocs-static-i18n): 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.\n- [MkDocs Theme i18n](https://github.com/mkdocs/mkdocs/pull/2299): Work in progress.\n- [Markdown i18n plugin](https://github.com/gisce/markdown-i18n): Provide translation of documents via po files but images cannot be localized.\n- [MkDocs Multilang](https://pypi.org/project/mkdocs-multilang/): Only released for MkDocs < 1.0\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "MkDocs i18n plugin",
"version": "0.4.6",
"split_keywords": [
"mkdocs",
"plugin",
"i18n"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40d09523dcdfaa9f6968a85e967225213e9ea79e046e8da65282af56e8dbd4c1",
"md5": "8f8e9bba26496c0a0ebf1e0f04414d4e",
"sha256": "44054cd7de6150f8e03aa074fc46d9ea661e660c9df0aab802115dd30636bc08"
},
"downloads": -1,
"filename": "mkdocs_i18n-0.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f8e9bba26496c0a0ebf1e0f04414d4e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.7",
"size": 17730,
"upload_time": "2023-04-27T11:48:07",
"upload_time_iso_8601": "2023-04-27T11:48:07.445232Z",
"url": "https://files.pythonhosted.org/packages/40/d0/9523dcdfaa9f6968a85e967225213e9ea79e046e8da65282af56e8dbd4c1/mkdocs_i18n-0.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b316aad3256057551b1b8b2c8447a3669bfb3c1f99f833280e167b8fedd1d97",
"md5": "dea724fd4d4424867cc2054b3fe4efae",
"sha256": "977736ac643e6a9fece2f331c72168dda298b09ed55049a9c3bb6be33e099af0"
},
"downloads": -1,
"filename": "mkdocs-i18n-0.4.6.tar.gz",
"has_sig": false,
"md5_digest": "dea724fd4d4424867cc2054b3fe4efae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.7",
"size": 24232,
"upload_time": "2023-04-27T11:48:09",
"upload_time_iso_8601": "2023-04-27T11:48:09.430723Z",
"url": "https://files.pythonhosted.org/packages/6b/31/6aad3256057551b1b8b2c8447a3669bfb3c1f99f833280e167b8fedd1d97/mkdocs-i18n-0.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-27 11:48:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "mkdocs-i18n"
}
