https://github.com/redislabs/mkdocs-include
An MkDocs plugin for including files in markdown
https://github.com/redislabs/mkdocs-include
Last synced: 9 months ago
JSON representation
An MkDocs plugin for including files in markdown
- Host: GitHub
- URL: https://github.com/redislabs/mkdocs-include
- Owner: RedisLabs
- License: mit
- Created: 2020-03-08T23:04:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-25T09:13:16.000Z (over 5 years ago)
- Last Synced: 2025-01-11T11:22:43.740Z (over 1 year ago)
- Language: Python
- Size: 2.93 KB
- Stars: 0
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs-include
This MkDocs plugin includes files in your markdown documents.
## Setup
Install the plugin using pip:
`pip install git+https://github.com/RedisLabs/mkdocs-include.git`
Activate the plugin in `mkdocs.yml`:
```yaml
plugins:
- search
- include:
src_path: docs/sources
```
> **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.
More information about plugins in the [MkDocs documentation][mkdocs-plugins].
## Config
* `src_path` - The path to your source files
## Usage
Assuming you have a file at "docs/sources/hello.c" and that the `src_path` property is set to "docs/sources" add the following to your .md file to include it:
```md
{{ include('hello.c') }}
```