Internationalization plugin for mkdocs
Project description
Mkdocs translations plugin
This plugin is inspired by mkdocs-static-i18n plugin, but it solves problem with tabs. With it, you can use nested documentation file structure.
Also, it's integrated with mkdocs-material theme features. Such as search, language switcher, and tabs.
For example, with the following configuration:
# Add this plugin in your mkdocs.yml
plugins:
- translations:
default_language: ru
languages:
en: english
ru: русский
It will turn this.
docs
├── Dir1
│ ├── index.md
│ ├── index.en.md
│ ├── Theme1.md
│ ├── Theme1.en.md
│ ├── Theme2.md
│ └── Theme2.en.md
├── index.en.md
├── index.md
└── Dir2
├── index.md
├── index.en.md
├── Theme1.md
└── Theme1.en.md
Into this:
site
├── 404.html
├── index.html
├── Dir1
│ ├── Theme1
│ │ └── index.html
│ ├── index.html
│ └── Theme2
│ └── index.html
├── Dir2
│ ├── Theme1
│ │ └── index.html
│ └── index.html
├── en
│ ├── Dir1
│ │ ├── Theme1
│ │ │ └── index.html
│ │ ├── index.html
│ │ └── Theme2
│ │ └── index.html
│ ├── index.html
│ └── Dir2
│ ├── Theme1
│ │ └── index.html
│ └── index.html
└── ru
├── Dir1
│ ├── Theme1
│ │ └── index.html
│ ├── index.html
│ └── Theme2
│ └── index.html
├── index.html
└── Dir2
├── Theme1
│ └── index.html
└── index.html
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mkdocs-translations-0.1.1.tar.gz
.
File metadata
- Download URL: mkdocs-translations-0.1.1.tar.gz
- Upload date:
- Size: 4.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.5 CPython/3.8.7 Linux/5.4.0-1040-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b858f4dc9a4c68265c5577e5e49c3d58c940dfed85bb2db5d75a1d249992c264 |
|
MD5 | 878ee39bd405986d7b5fc8d3680dad4b |
|
BLAKE2b-256 | aef0da014b21230d21c46739ee68938e8a7eec22fecdcc1e5c4cab284f27df3f |
File details
Details for the file mkdocs_translations-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: mkdocs_translations-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.5 CPython/3.8.7 Linux/5.4.0-1040-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7a895a07d74d32e2b15955b69b8e74b62b93e6cbb15d65f63abfc7266ccbdf7 |
|
MD5 | 8b467bad3e34252b6aef04d80c618e6e |
|
BLAKE2b-256 | d14a7ba44fe897f96d227d148f6ed8da5ce8da4a095f7ca3e482cf5aefa618b2 |