Metadata-Version: 1.2
Name: mkdocs-markdownextradata-plugin
Version: 0.0.3
Summary: A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template
Home-page: https://github.com/rosscdh/mkdocs-markdownextradata-plugin/
Author: Ross Crawford-d'Heureuse
Author-email: sendrossemail@gmail.com
License: MIT
Description: # mkdocs-markdownextradata-plugin
        
        *A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template*
        
        **usecase**
        
        ```
        As a user with variables that need to be inserted at the markdown level, not the template level.
        I need a mkdocs plugin that will inject my `extras` variables into the markdown template before it gets rendered to html.
        So that I can build my markdown pages with different values for images, urls, client_names, etc. 
        ```
        
        <br/>
        
        ## Installation
        
        > **Note:** This package requires MkDocs version 0.17 or higher. 
        
        Install the package with pip:
        
        ```bash
        pip install mkdocs-markdownextra-plugin
        ```
        
        Enable the plugin in your `mkdocs.yml`:
        
        ```yaml
        plugins:
            - search
            - markdownextra
        ```
        
        > **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.
        
        More information about plugins in the [MkDocs documentation][mkdocs-plugins]
        
        <br/>
        
        ## Features
        
        ### Use Extra Variables in your markdown files
        
        The variables you define in the mkdown.yml `extra:` slot will become available in your templates
        
        ```yaml
        extra:
          customer:
            name: Your name here
            web: www.example.com
            salt: salt.example.com
        ```
        
        and then in your `*.md` files
        
        ```jinja
        {{ customer.name }}
        <a href="{{ customer.web }}">{{ customer.web }}</a>
        ```
        
        <br/>
        
        ## Contributing
        
        From reporting a bug to submitting a pull request: every contribution is appreciated and welcome.
        Report bugs, ask questions and request features using [Github issues][github-issues].
        If you want to contribute to the code of this project, please read the [Contribution Guidelines][contributing].
        
        [travis-status]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master
        [travis-link]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin
        [mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
        [github-issues]: https://github.com/rosscdh/mkdocs-markdownextradata-plugin/issues
        [contributing]: CONTRIBUTING.md
        
Keywords: mkdocs python markdown extra values
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.5
