mkdocs-include-markdown-plugin 0.1.0

Mkdocs Markdown includer plugin.

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.