A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template
Project description
# mkdocs-markdownextradata-plugin
*A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template*
**usecase**
```
As a user with variables that need to be inserted at the markdown level, not the template level.
I need a mkdocs plugin that will inject my `extras` variables into the markdown template before it gets rendered to html.
So that I can build my markdown pages with different values for images, urls, client_names, etc.
```
<br/>
## Installation
> **Note:** This package requires MkDocs version 0.17 or higher.
Install the package with pip:
```bash
pip install mkdocs-markdownextradata-plugin
```
Enable the plugin in your `mkdocs.yml`:
```yaml
plugins:
- search
- markdownextradata
```
> **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]
<br/>
## Features
### Use Extra Variables in your markdown files
The variables you define in the mkdown.yml `extra:` slot will become available in your templates
```yaml
extra:
customer:
name: Your name here
web: www.example.com
salt: salt.example.com
```
and then in your `*.md` files
```jinja
{{ customer.name }}
<a href="{{ customer.web }}">{{ customer.web }}</a>
```
<br/>
## Contributing
From reporting a bug to submitting a pull request: every contribution is appreciated and welcome.
Report bugs, ask questions and request features using [Github issues][github-issues].
If you want to contribute to the code of this project, please read the [Contribution Guidelines][contributing].
[travis-status]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master
[travis-link]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin
[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
[github-issues]: https://github.com/rosscdh/mkdocs-markdownextradata-plugin/issues
[contributing]: CONTRIBUTING.md
*A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template*
**usecase**
```
As a user with variables that need to be inserted at the markdown level, not the template level.
I need a mkdocs plugin that will inject my `extras` variables into the markdown template before it gets rendered to html.
So that I can build my markdown pages with different values for images, urls, client_names, etc.
```
<br/>
## Installation
> **Note:** This package requires MkDocs version 0.17 or higher.
Install the package with pip:
```bash
pip install mkdocs-markdownextradata-plugin
```
Enable the plugin in your `mkdocs.yml`:
```yaml
plugins:
- search
- markdownextradata
```
> **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]
<br/>
## Features
### Use Extra Variables in your markdown files
The variables you define in the mkdown.yml `extra:` slot will become available in your templates
```yaml
extra:
customer:
name: Your name here
web: www.example.com
salt: salt.example.com
```
and then in your `*.md` files
```jinja
{{ customer.name }}
<a href="{{ customer.web }}">{{ customer.web }}</a>
```
<br/>
## Contributing
From reporting a bug to submitting a pull request: every contribution is appreciated and welcome.
Report bugs, ask questions and request features using [Github issues][github-issues].
If you want to contribute to the code of this project, please read the [Contribution Guidelines][contributing].
[travis-status]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master
[travis-link]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin
[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
[github-issues]: https://github.com/rosscdh/mkdocs-markdownextradata-plugin/issues
[contributing]: CONTRIBUTING.md
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
Close
Hashes for mkdocs-markdownextradata-plugin-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64d1c966b288d653f51f7531c03204eb988d0d77e56055c9d703d99105259a36 |
|
MD5 | 1ad709fb49bc68442aa3bb525aef87af |
|
BLAKE2b-256 | e08a1516b61759047583df8ca5725c7926a34acc8e50f965d856949a3562c42d |