{ "info": { "author": "Michael Privat", "author_email": "Michael.Privat@availity.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# mkdocs-snippet-plugin\n\nAn mkdocs plugin that injects snippets from a file in a git repository.\n\n## Installation\n\n> **Note:** This package requires MkDocs version 0.17 or higher.\n\nInstall the package with pip:\n\n```bash\npip install mkdocs-snippet-plugin\n```\n\nEnable the plugin in your `mkdocs.yml`:\n\n```yaml\nplugins:\n - snippet:\n base_path: docs\n```\n\nThe `base_path` entry should point to the root of your documentation site, usually defaulted to `docs`.\n\n## How to use it\n\nIf 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:\n\n```\n{{ snippet('git@github.com:mprivat/mkdocs-snippet-plugin.git', 'README.md', '## Installation') }}\n```\n\nIt 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.\n\nIf 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.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mprivat/mkdocs-snippet-plugin", "keywords": "mkdocs python markdown snippet", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "mkdocs-snippet-plugin", "package_url": "https://pypi.org/project/mkdocs-snippet-plugin/", "platform": "", "project_url": "https://pypi.org/project/mkdocs-snippet-plugin/", "project_urls": { "Homepage": "https://github.com/mprivat/mkdocs-snippet-plugin" }, "release_url": "https://pypi.org/project/mkdocs-snippet-plugin/1.0.1/", "requires_dist": [ "mkdocs (>=0.17)", "gitpython" ], "requires_python": ">=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*", "summary": "An mkdocs plugin that injects snippets from a file in a git repository", "version": "1.0.1" }, "last_serial": 4879070, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "df49b7d4364bc889dec93ebb643cf696", "sha256": "941f844c9b46ebce517bb75856fcaf6e1f3e7fe21adeba70e4dc4d5c679c2e37" }, "downloads": -1, "filename": "mkdocs_snippet_plugin-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "df49b7d4364bc889dec93ebb643cf696", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*", "size": 3085, "upload_time": "2019-02-27T19:59:22", "url": "https://files.pythonhosted.org/packages/35/a0/d63db855dc9865263fa44f24c65e4b9c1df3df9af6f9d05cb92db97cd5e3/mkdocs_snippet_plugin-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "587597a1f4de29da3b045df22c50ca04", "sha256": "7a885313d45f6f7f8636af1ace52fa6614366762514e5543e420f67d437c90be" }, "downloads": -1, "filename": "mkdocs-snippet-plugin-1.0.0.tar.gz", "has_sig": false, "md5_digest": "587597a1f4de29da3b045df22c50ca04", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*", "size": 1960, "upload_time": "2019-02-27T19:59:24", "url": "https://files.pythonhosted.org/packages/de/4a/73b2f69025777264e6031be75a2d3d15ca445a546128a3b29798520e5248/mkdocs-snippet-plugin-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "da57f6f022354861bc0bd26dbad48fce", "sha256": "746a734b317f4ba8f7e1e56f0274a9d91f4c675844c783ff6b527dd9df2b5122" }, "downloads": -1, "filename": "mkdocs_snippet_plugin-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "da57f6f022354861bc0bd26dbad48fce", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*", "size": 4415, "upload_time": "2019-02-28T12:44:44", "url": "https://files.pythonhosted.org/packages/db/07/2ba25e9137f5ded929ae3e0c045006124d03248d72541fba5cbc562fdb00/mkdocs_snippet_plugin-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "02adf60a6d55a69804110bd50656cd4d", "sha256": "0a6479969b2dea6da261b665eaefd74928979a747b37e7b441f61e9fad42a97c" }, "downloads": -1, "filename": "mkdocs-snippet-plugin-1.0.1.tar.gz", "has_sig": false, "md5_digest": "02adf60a6d55a69804110bd50656cd4d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*", "size": 3014, "upload_time": "2019-02-28T12:44:46", "url": "https://files.pythonhosted.org/packages/1b/43/df960b4b9cbe2cbb6ddf2d5383de359e9f2c29870354def666494e106eea/mkdocs-snippet-plugin-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "da57f6f022354861bc0bd26dbad48fce", "sha256": "746a734b317f4ba8f7e1e56f0274a9d91f4c675844c783ff6b527dd9df2b5122" }, "downloads": -1, "filename": "mkdocs_snippet_plugin-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "da57f6f022354861bc0bd26dbad48fce", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*", "size": 4415, "upload_time": "2019-02-28T12:44:44", "url": "https://files.pythonhosted.org/packages/db/07/2ba25e9137f5ded929ae3e0c045006124d03248d72541fba5cbc562fdb00/mkdocs_snippet_plugin-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "02adf60a6d55a69804110bd50656cd4d", "sha256": "0a6479969b2dea6da261b665eaefd74928979a747b37e7b441f61e9fad42a97c" }, "downloads": -1, "filename": "mkdocs-snippet-plugin-1.0.1.tar.gz", "has_sig": false, "md5_digest": "02adf60a6d55a69804110bd50656cd4d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*", "size": 3014, "upload_time": "2019-02-28T12:44:46", "url": "https://files.pythonhosted.org/packages/1b/43/df960b4b9cbe2cbb6ddf2d5383de359e9f2c29870354def666494e106eea/mkdocs-snippet-plugin-1.0.1.tar.gz" } ] }