Metadata-Version: 2.1
Name: mkdocs-mdpo-plugin
Version: 0.0.10
Summary: Mkdocs plugin for translations using PO files.
Home-page: https://github.com/mondeja/mkdocs-mdpo-plugin
Author: Álvaro Mondéjar Rubio
Author-email: mondejar1994@gmail.com
License: BSD-3-Clause
Description: # mkdocs-mdpo-plugin
        
        [![PyPI version](https://img.shields.io/pypi/v/mkdocs-mdpo-plugin?label=version)](https://pypi.org/project/mkdocs-mdpo-plugin)
        [![Test](https://img.shields.io/github/workflow/status/mondeja/mkdocs-mdpo-plugin/CI?label=tests&logo=github)](https://github.com/mondeja/mkdocs-mdpo-plugin/actions?query=workflow%3ACI)
        [![Documentation](https://img.shields.io/github/workflow/status/mondeja/mkdocs-mdpo-plugin/Github%20Pages?label=docs&logo=github)](https://mondeja.github.io/mkdocs-mdpo-plugin)
        [![Coverage status](https://img.shields.io/coveralls/github/mondeja/mkdocs-mdpo-plugin?logo=coveralls)](https://coveralls.io/github/mondeja/mkdocs-mdpo-plugin)
        
        <!--description-start-->
        
        Translations for Mkdocs using PO files, fully customizable.
        Compatible with [mkdocs-material](https://squidfunk.github.io/mkdocs-material),
        based on [mdpo][mdpo-docs].
        
        <!--description-end-->
        
        Check the [full documentation here](https://mondeja.github.io/mkdocs-mdpo-plugin).
        
        <!--intro-start-->
        
        ## Install
        
        ```
        pip install mkdocs-mdpo-plugin
        ```
        
        ## Usage
        
        Enable the plugin in your `mkdocs.yml`:
        
        ```yaml
        plugins:
          - mdpo
        ```
        
        ### Minimal configuration
        
        #### With [mkdocs-material](https://squidfunk.github.io/mkdocs-material)
        
        ```yaml
        theme:
          name: material
          language: en
        
        extra:
          alternate:
            - name: English
              lang: en
            - name: Español
              link: es
              lang: es
        
        plugins:
          - mdpo
        ```
        
        #### Standalone
        
        <!-- mdpo-include-codeblock -->
        ```yaml
        plugins:
          - mdpo:
              languages:
                - en     # first language is the original
                - es
        ```
        
        Both previous configurations will create the same layout of files building the
        documentation. Given the next layout in a `docs/` directory:
        
        ```
        docs
        └── index.md
        ```
        
        After the build, you will get:
        
        ```
        docs
        ├── es
        │   └── index.md.po
        └── index.md
        ```
        
        Just translate the strings in `docs/es/index.md.po` into Spanish, build again
        with `mkdocs build` and the `site/` directory will look like:
        
        ```
        site
        ├── 404.html
        ├── assets
        │   ├── images
        │   ├── javascripts
        │   └── stylesheets
        ├── es
        │   └── index.html
        ├── index.html
        ├── sitemap.xml
        └── sitemap.xml.gz
        ```
        
        <!--intro-end-->
        
        Simple and easy. The extraction of messages process and the produced
        layout are fully customizable, you can even translate code blocks!
        [Check the full documentation here](https://mondeja.github.io/mkdocs-mdpo-plugin).
        
        [mdpo-docs]: https://mdpo.readthedocs.io
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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 :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: lint
Provides-Extra: test
