Skip to main content

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

Metadata

Release files for mkdocs-translations 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-translations 0.1.1
File Size Uploaded
mkdocs-translations-0.1.1.tar.gz 4.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-translations 0.1.1
File Interpreter ABI Platform
mkdocs_translations-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 9.2 kB

Release files / mkdocs-translations-0.1.1.tar.gz

Download URL mkdocs-translations-0.1.1.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b858f4dc9a4c68265c5577e5e49c3d58c940dfed85bb2db5d75a1d249992c264
BLAKE2b-256 checksum
How to use checksums
aef0da014b21230d21c46739ee68938e8a7eec22fecdcc1e5c4cab284f27df3f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.8.7 Linux/5.4.0-1040-azure

Release files / mkdocs_translations-0.1.1-py3-none-any.whl

Download URL mkdocs_translations-0.1.1-py3-none-any.whl
Size 4.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b7a895a07d74d32e2b15955b69b8e74b62b93e6cbb15d65f63abfc7266ccbdf7
BLAKE2b-256 checksum
How to use checksums
d14a7ba44fe897f96d227d148f6ed8da5ce8da4a095f7ca3e482cf5aefa618b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.8.7 Linux/5.4.0-1040-azure

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page