Metadata-Version: 2.1
Name: mkdocs-static-i18n
Version: 0.2
Summary: MkDocs i18n plugin using static translation markdown files
Home-page: https://github.com/ultrabug/mkdocs-static-i18n
Author: Ultrabug
Author-email: ultrabug@ultrabug.net
License: MIT
Download-URL: https://github.com/ultrabug/mkdocs-static-i18n/tags
Description: # MkDocs static i18n plugin
        
        *An MkDoc plugin that helps you support multiple language versions of your site / documentation.*
        
        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**!
        
        If you want to see how it looks, [check out the demo documentation here](https://ultrabug.github.io/mkdocs-static-i18n/).
        
        ## Language detection logic
        
        This plugin is made to be as simple as possible and will generate a default version of your website + one per configured language on the `<language>/` path.
        
        - the `default` version will use any `.md` documentation file first and fallback to any `.<default_language>.md` file found
        - the `/<language>` language versions will use any `.<language>.md` documentation file first and fallback to any `.<default_language>.md` file before fallbacking to any default `.md` file found
        
        Since demonstrations are better than words, [check out the demo documentation here](https://ultrabug.github.io/mkdocs-static-i18n/) which showcases the logic.
        
        ## Installation
        
        Just `pip install mkdocs-static-i18n`!
        
        ## Configuration
        
        All the parameters are mandatory:
        
        - **default_language**: string
        - **languages**: mapping of **language name**: **display value**
        
        ```
        plugins:
          - i18n:
              default_language: en
              languages:
                en: english
                fr: français
        ```
        
        ## Example output
        
        Using the configuration above on the following `docs/` structure will build the following `site/` (leaving out static files for readability):
        
        ```
        docs
        ├── index.fr.md
        ├── index.md
        ├── topic1
        │   ├── index.en.md
        │   └── index.fr.md
        └── topic2
            ├── index.en.md
            └── index.md
        ```
        
        ```
        site
        ├── en
        │   ├── index.html
        │   ├── topic1
        │   │   └── index.html
        │   └── topic2
        │       └── index.html
        ├── fr
        │   ├── index.html
        │   ├── topic1
        │   │   └── index.html
        │   └── topic2
        │       └── index.html
        ├── index.html
        ├── topic1
        │   └── index.html
        └── topic2
            └── index.html
        ```
        
        ## Compatibility with other plugins
        
        This plugin is compatible with the following mkdocs plugins:
        
        - [MkDocs Material](https://github.com/squidfunk/mkdocs-material): the `search` plugin text will be switched automatically to the right language depending on the version you're browsing
        - [MkDocs Awesome Pages Plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin): the page ordering is preserved on the language specific versions of your site
        
        ## TODO
        
        - add mkdocs-material example with language switcher buttons, meanwhile [you can see how it looks on my website](https://ultrabug.fr).
        
        ## Contributions welcome!
        
        Feel free to ask questions, enhancements and to contribute to this project!
        
Platform: any
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
