Mkdocs Markdown includer plugin.
Project description
mkdocs-include-markdown-plugin
Mkdocs Markdown includer plugin.
Status
Installation
pip install mkdocs-include-markdown-plugin
Documentation
Setup
Enable the plugin in your mkdocs.yml
:
plugins:
- include-markdown
Directives
This plugin includes two directives, one to include markdown files and another to include files of any type:
include-markdown
Includes markdown file content, optionally using two delimiters to filter the content to include.
- start Delimiter that marks the beginning of the content to include.
- end Delimiter that marks the end of the content to include.
Example
{%
include-markdown "../README.md"
start="<!--intro-start-->"
end="<!--intro-end-->"
%}
include
Includes arbitrary file content.
Example
```yaml
{% include "../examples/github-minimal.yml" %}
```
Acknowledgment
- Joe Rickerby and contributors for giving me the permissions to separate this plugin from the documentation of cibuildwheel.
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
Close
Hashes for mkdocs_include_markdown_plugin-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a47916e5688488e52b8905116898cf080b574074a4ff2995306dfb172e05ebb2 |
|
MD5 | a42e3fc03f1b3534068af197749d53ea |
|
BLAKE2b-256 | 4ba35a0bcfe51685b9ad0e5c92f8835b5ccce3d8a60544ffead1da177cd335ab |
Close
Hashes for mkdocs_include_markdown_plugin-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e31030720f191d228faa352df3334397e9f01dce6b6e705a69447e8ef87ae406 |
|
MD5 | 0a9b9e1afd816400112400fb0c329d90 |
|
BLAKE2b-256 | f31916c7f94e24793ed2c2f8a80fdf6045f1a1217d829a59426bb5688d653cbb |