Metadata-Version: 2.1
Name: mkdocs-snippet-plugin
Version: 1.0.2
Summary: An mkdocs plugin that injects snippets from a file in a git repository
Home-page: https://github.com/mprivat/mkdocs-snippet-plugin
Author: Michael Privat
Author-email: Michael.Privat@availity.com
License: MIT
Description: # mkdocs-snippet-plugin
        
        An mkdocs plugin that injects snippets from a file in a git repository.
        
        ## Installation
        
        > **Note:** This package requires MkDocs version 0.17 or higher.
        
        Install the package with pip:
        
        ```bash
        pip install mkdocs-snippet-plugin
        ```
        
        Enable the plugin in your `mkdocs.yml`:
        
        ```yaml
        plugins:
            - snippet:
                  base_path: docs
        ```
        
        The `base_path` entry should point to the root of your documentation site, usually defaulted to `docs`.
        
        ## How to use it
        
        If you have a markdown file in a remote Git repostory, and you want to extract a sections from it, add the following to your documentation markdown in mkdocs:
        
        ```
        {{ snippet('git@github.com:mprivat/mkdocs-snippet-plugin.git', 'README.md', '## Installation') }}
        ```
        
        It will download the file you specify from the Git URL, extract the section you ask for (including its subsections) and inject that into your mkdocs file at render time.
        
        If the remote file has references to images, those will also be downloaded and placed in a `_gen` folder in the mkdocs hierarchy. You will probably want to include `**/gen_` in your `.gitignore` file so you don't put those into your git repository unless you want them there.
        
Keywords: mkdocs python markdown snippet
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 :: 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.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Description-Content-Type: text/markdown
