Metadata-Version: 2.1
Name: mkdocs-user-defined-values
Version: 0.0.3
Summary: Enable user defined values for MkDocs
Home-page: https://github.com/rahult/mkdocs-user-defined-values
Author: Rahul Trikha
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/rahult/mkdocs-user-defined-values/issues
Project-URL: Source, https://github.com/rahult/mkdocs-user-defined-values/
Description: # mkdocs-user-defined-values
        
        This is a plugin for a MkDocs which allows pages to have user defined input values.
        
        ## Setup
        
        Install the plugin using pip:
        
        `pip install mkdocs-user-defined-values`
        
        Activate the plugin in `mkdocs.yml`:
        
        ```yaml
        plugins:
          - search
          - user-defined-values:
              keywords:
                - DOC_AS_CODE_PATH
                - DOC_AS_CODE_VERSION
        ```
        
        > **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].
        
        ## Config
        
        * `keywords` - This is a list of keywords which you want to allow a user to modify.
        * `input-placeholder` - This is a placeholder where you want the plugin to generate the form for user to provide dynamic values for each keyword. Default value is `{{{user-defined-values}}}`.
        
        ## Usage
        
        * Provide a list of `keywords` you want a user to provide dynamically.
        * Place `{{{user-defined-values}}}` in your page or template where you want to generate the form for user to provide dynamic values.
        
        ## See Also
        
        More information about templates [here][mkdocs-template].
        
        More information about blocks [here][mkdocs-block].
        
        [mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
        [mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables
        [mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks
Keywords: mkdocs plugin user defined value
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
