Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-translations-0.1.1.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_translations-0.1.1-py3-none-any.whl (4.7 kB view hashes)

Uploaded Python 3

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