Metadata-Version: 2.1
Name: mkdocs-redirects
Version: 0.0.6
Summary: A MkDocs plugin for dynamic page redirects to prevent broken links.
Home-page: https://github.com/datarobot/mkdocs-redirects
Author: Dustin Burke
Author-email: dustin@datarobot.com
License: MIT
Description: # mkdocs-redirects
        Open source plugin for Mkdocs page redirects
        
        ## Installing
        
        > **Note:** This package requires MkDocs version 1.0.4 or higher. 
        
        Install with pip:
        
        ```bash
        pip install mkdocs-redirects
        ```
        
        Enable the plugin in your `mkdocs.yml`:
        
        ```yaml
        plugins:
            - search
            - redirects
        ```
        
        ## Using
        
        In your `mkdocs.yml`, add a `redirects` block that maps the old page location to the new location:
        
        ```
        redirects:
          'old': 'some/new_location'
          'something/before': 'another/moved/file'
          'external': 'http://google.com'
        ```
        
        Note that the `.html` extension should be omitted (and will be automatically appended).
        
        The plugin will dynamically create `old.html`, `something/before.html`, and `external.html` in your configured `site_dir` with
        HTML that will include a meta redirect to the new page location.
        
        If the new location does not start with `http` or `HTTP` then it will also be appended with `.html` extension and is assumed to be relative to the root of the site.
        
        For nested subfolders, the plugin will automatically create these directories in the `site_dir`.
        
        ## Contributing
        
        - Pull requests are welcome.
        - File bugs and suggestions in the Github Issues tracker.
        
        ## Releasing
        
        ```
            make release
        ```
        
        It will prompt you for your PyPI user and password.
        
        See:
        - https://packaging.python.org/tutorials/packaging-projects/
        - https://packaging.python.org/guides/migrating-to-pypi-org/
        
Keywords: mkdocs redirect
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=2.7
Description-Content-Type: text/markdown
Provides-Extra: release
