# mkdocs-include

**Repository Path**: mirrors_RedisLabs/mkdocs-include

## Basic Information

- **Project Name**: mkdocs-include
- **Description**: An MkDocs plugin for including files in markdown
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-01-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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') }}
```