| Name | mkdocs-static-i18n JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | MkDocs i18n plugin using static translation markdown files |
| upload_time | 2025-01-24 09:03:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MkDocs static i18n plugin
*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](https://ultrabug.github.io/mkdocs-static-i18n/).
TL;DR? There's a [quick start guide](https://ultrabug.github.io/mkdocs-static-i18n/getting-started/quick-start/) 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](https://ultrabug.github.io/mkdocs-static-i18n/setup/upgrading-to-1/) to ease updating your `mkdocs.yml` file!
## See it in action
This plugin is proudly bringing localized content of [hundreds of projects](https://github.com/ultrabug/mkdocs-static-i18n/network/dependents) to their users.
Check it out live:
- [On this repository documentation](https://ultrabug.github.io/mkdocs-static-i18n/)
- [On my own website: ultrabug.fr](https://ultrabug.fr)
But also in our hall of fame:
- [AWS Copilot CLI](https://aws.github.io/copilot-cli/)
- [OWASP Top 10](https://github.com/OWASP/Top10)
- [Spaceship Prompt](https://spaceship-prompt.sh/)
- [FederatedAI FATE](https://fate.readthedocs.io/en/latest/)
- [Privacy Guides Org](https://www.privacyguides.org/en/)
- [Computer Science Self Learning Wiki](https://csdiy.wiki/)
## Contributions welcome
Feel free to ask questions, enhancements and to contribute to this project!
## Development
The project is managed with `hatch`. [Install `hatch`](https://hatch.pypa.io/1.9/install/#gui-installer) first.
Run the tests:
```
hatch run test:test
hatch run style:check
```
Serve the documentation:
```
hatch run doc:serve
```
## Credits
- Logo by [max.icons](https://www.flaticon.com/authors/maxicons)
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-static-i18n",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Ultrabug <ultrabug@ultrabug.net>",
"download_url": "https://files.pythonhosted.org/packages/03/2b/59652a2550465fde25ae6a009cb6d74d0f7e724d272fc952685807b29ca1/mkdocs_static_i18n-1.3.0.tar.gz",
"platform": null,
"description": "\n\n# MkDocs static i18n plugin\n\n\n\n*The MkDocs plugin that helps you support multiple language versions of your site / documentation.*\n\n*Like what you :eyes:? Using this plugin? Give it a :star:!*\n\nThe `mkdocs-static-i18n` plugin allows you to support multiple languages of your documentation by adding static translation files to your existing documentation pages.\n\nMulti language support is just **one `.<language>.md` file away**!\n\nEven better, `mkdocs-static-i18n` also allows you to build and serve localized versions of any file extension to display localized images, medias and assets.\n\nLocalized images/medias/assets are just **one `.<language>.<extension>` file away**!\n\nDon't like file suffixes? You're more into a folder based structure? We got you covered as well!\n\n## Documentation\n\nCheck out the [plugins' documentation here](https://ultrabug.github.io/mkdocs-static-i18n/).\n\nTL;DR? There's a [quick start guide](https://ultrabug.github.io/mkdocs-static-i18n/getting-started/quick-start/) for you!\n\n## Upgrading from 0.x versions\n\n:warning: Version 1.0.0 brings **breaking changes** to the configuration format of the plugin. Check out the [upgrade to v1.0.0 guide](https://ultrabug.github.io/mkdocs-static-i18n/setup/upgrading-to-1/) to ease updating your `mkdocs.yml` file!\n\n## See it in action\n\nThis plugin is proudly bringing localized content of [hundreds of projects](https://github.com/ultrabug/mkdocs-static-i18n/network/dependents) to their users.\n\nCheck it out live:\n\n- [On this repository documentation](https://ultrabug.github.io/mkdocs-static-i18n/)\n- [On my own website: ultrabug.fr](https://ultrabug.fr)\n\nBut also in our hall of fame:\n\n- [AWS Copilot CLI](https://aws.github.io/copilot-cli/)\n- [OWASP Top 10](https://github.com/OWASP/Top10)\n- [Spaceship Prompt](https://spaceship-prompt.sh/)\n- [FederatedAI FATE](https://fate.readthedocs.io/en/latest/)\n- [Privacy Guides Org](https://www.privacyguides.org/en/)\n- [Computer Science Self Learning Wiki](https://csdiy.wiki/)\n\n## Contributions welcome\n\nFeel free to ask questions, enhancements and to contribute to this project!\n\n## Development\n\nThe project is managed with `hatch`. [Install `hatch`](https://hatch.pypa.io/1.9/install/#gui-installer) first.\n\nRun the tests:\n\n```\nhatch run test:test\nhatch run style:check\n```\n\nServe the documentation:\n\n```\nhatch run doc:serve\n```\n\n## Credits\n\n- Logo by [max.icons](https://www.flaticon.com/authors/maxicons)\n",
"bugtrack_url": null,
"license": null,
"summary": "MkDocs i18n plugin using static translation markdown files",
"version": "1.3.0",
"project_urls": {
"Documentation": "https://github.com/ultrabug/mkdocs-static-i18n#readme",
"Download": "https://github.com/ultrabug/mkdocs-static-i18n/tags",
"Funding": "https://ultrabug.fr/#support-me",
"Homepage": "https://github.com/ultrabug/mkdocs-static-i18n",
"Source": "https://github.com/ultrabug/mkdocs-static-i18n",
"Tracker": "https://github.com/ultrabug/mkdocs-static-i18n/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "caf7ef222a7a2f96ecf79c7c00bfc9dde3b22cd2cc1bd2b7472c7b204fc64225",
"md5": "e70a612a0ee2ace1b4133d38ab829682",
"sha256": "7905d52fff71d2c108b6c344fd223e848ca7e39ddf319b70864dfa47dba85d6b"
},
"downloads": -1,
"filename": "mkdocs_static_i18n-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e70a612a0ee2ace1b4133d38ab829682",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21660,
"upload_time": "2025-01-24T09:03:22",
"upload_time_iso_8601": "2025-01-24T09:03:22.461204Z",
"url": "https://files.pythonhosted.org/packages/ca/f7/ef222a7a2f96ecf79c7c00bfc9dde3b22cd2cc1bd2b7472c7b204fc64225/mkdocs_static_i18n-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "032b59652a2550465fde25ae6a009cb6d74d0f7e724d272fc952685807b29ca1",
"md5": "e5cf4243fcbdafe2894a720ace7254d8",
"sha256": "65731e1e4ec6d719693e24fee9340f5516460b2b7244d2a89bed4ce3cfa6a173"
},
"downloads": -1,
"filename": "mkdocs_static_i18n-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "e5cf4243fcbdafe2894a720ace7254d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1370450,
"upload_time": "2025-01-24T09:03:24",
"upload_time_iso_8601": "2025-01-24T09:03:24.389863Z",
"url": "https://files.pythonhosted.org/packages/03/2b/59652a2550465fde25ae6a009cb6d74d0f7e724d272fc952685807b29ca1/mkdocs_static_i18n-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 09:03:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ultrabug",
"github_project": "mkdocs-static-i18n#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-static-i18n"
}
