Skip to main content

An mkdocs plugin that injects snippets from a file in a git repository

Project 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:

pip install mkdocs-snippet-plugin

Enable the plugin in your mkdocs.yml:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-snippet-plugin, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_snippet_plugin-1.0.2-py3-none-any.whl (4.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mkdocs-snippet-plugin-1.0.2.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page