Mkdocs plugin that allow to inject snippet or all markdown content from a given remote git repository.
Project description
# About
MkDocs plugin that allow to inject snippet or all markdown content from a given remote git repository. The goal is to show different markdowns from different projects inside a MkDocs, you put together all info across some projects.
## Installation
Install the package with pip:
`bash pip install mkdocs-gitsnippet-plugin `
## Configuration
Enable the plugin in your mkdocs.yml if you didn’t change the folder name that contain your documentation source files. By default docs.
`yaml plugins: - gitsnippet `
Enable the plugin in your mkdocs.yml if you changed the folder name that contain your documentation source files. By default docs.
`yaml plugins: - gitsnippet: base_path: docs `
> This package requires MkDocs version 0.17 or higher.
## Usage
mkdocs-gitsnippet-plugin will download the file you specify from a remote git repository, extract the section or all content and inject that into you MkDocs file at render time.
### Snippet a section
If you want to extract a section from a remote git repository, you can add the following to your markdown in MkDocs:
`markdown {{ gitsnippet('git@github.com:SamazoOo/mkdocs-gitsnippet-plugin.git', 'README.md', '## Installation') }} ` ### All markdown content
If you want to get all context from a markdown in a remote git repository, you can add the following to your markdown in MkDocs:
`markdown {{ gitsnippet('git@github.com:SamazoOo/mkdocs-gitsnippet-plugin.git', 'README.md', '') }} `
### Images references
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-gitsnippet-plugin-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 750777526a9c96d9916151ab27b0d4616a449b5294d7025d562a0727948320bc |
|
MD5 | 1fa72da6b2ce117162146e737c23c216 |
|
BLAKE2b-256 | ca027d44e9bf34bc54270f82d42328b271a90fb066e5df7b17e641538d6d75b3 |
Hashes for mkdocs_gitsnippet_plugin-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67d75d83b9dfc75abc6a8257294c4e855d75b17c38ffad45bc39a64ad553a2f1 |
|
MD5 | 47ed57748d48485edfba1e6fbf1fb1d2 |
|
BLAKE2b-256 | c643461648903229c30f2b7e0cd8665f66853b70fa18b9b31aba481fd4208509 |