Metadata-Version: 2.1
Name: mkdocs-versioning
Version: 0.3.1
Summary: A tool that allows for versioning sites built with mkdocs
Home-page: https://github.com/zayd62/mkdocs-versioning
Author: Zayd Patel
Author-email: zayd62@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://zayd62.github.io/mkdocs-versioning/
Description: # mkdocs-versioning
        
        `mkdocs-versioning` is a plugin for [mkdocs](https://www.mkdocs.org/), a tool designed to create static websites usually for generating project documentation. 
        
        `mkdocs-versioning` extends mkdocs by differentiating between different versions of documentation you may build. For example, a newer versions of some software may work differently from an older version and it is important that users of an older version of the software reads the appropriate version of the documentation in order to ensure that the user has the correct information and uses the software appropriately.
        
        ## Setup
        
        Install the plugin using pip:
        
        ```bash
        pip install mkdocs-versioning
        ```
        
        Next, add the following lines to your `mkdocs.yml`:
        
        ```yml
        plugins:
          - search
          - mkdocs-versioning:
              version: 0.3.0
        ```
        
        > 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.
        
        ## Usage
        
        Instructions on how to use the plugin is available at https://zayd62.github.io/mkdocs-versioning/
        
        ## Contributing 
        
        Please note that mkdocs-versioning is currently in **Beta** and there may be missing feature/documentation so if you could help out by either:
        
        1. finding and reporting bugs
        2. contributing by checking out the [issues](https://github.com/zayd62/mkdocs-versioning/issues)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6
Description-Content-Type: text/markdown
