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.
Note: This package requires MkDocs version 0.17 or higher.
Install the package with pip:
pip install mkdocs-markdownextradata-pluginEnable the plugin in your mkdocs.yml:
plugins:
- search
- markdownextradata: {}You are then able to use the mkdocs extra: {} hash to pass context data into your files
Note: If you have no
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set, but now you have to enable it explicitly.
The variables you define in the mkdown.yml extra: slot will become available in your templates
site_name: My fantastic site
plugins:
- search
- markdownextradata
extra:
customer:
name: Your name here
web: www.example.com
salt: salt.example.comand then in your *.md files
{{ customer.name }}
<a href="{{ customer.web }}">{{ customer.web }}</a>If the extra: {} hash is not enough for your data then you are able to make use of external yaml files to provide that context data
plugins:
- search
- markdownextradata:
data: path/to/datafilesor if you have multiple locations provide a comma (,) separated list of locations
plugins:
- search
- markdownextradata:
data: path/to/datafiles, another/path/to/datafilesif you leave markdownextradata.data empty
plugins:
- search
- markdownextradataby default it will search in the folder where your mkdocs.yml is kept
and in the docs folder for another folder called _data
(i.e. ./docs/_data/site.yaml), available as {{ site.whatever_variable_in_the_yaml}}.
If these paths are found, the plugin will read all .yml|.yaml and .json
files inside them and add the data in them under the extra key.
For example, if you have a file called [path/to/datafiles/]sections/captions.yaml
which includes a variable foo - where [path/to/datafiles/] is the path declared
in your configuration under data - the data inside that file will be available in
your templates as {{sections.captions.foo}} or {{sections['captions']['foo']}}.
Alternatively, you can access all files and variable declared under data in template
using extra key.
This is particularly useful if your folder or filename do not comply with the Python
variable naming rules.
For example, if you have a file [path/to/datafiles/]1_example/captions.yaml
which includes a variable bar, writting the template as
{{1_example.captions.bar}} returns a jinja2.exceptions.TemplateSyntaxError since
the folder 1_example starts with a number. Instead, you can call this file with
when the template is {{extra['1_example']['captions']['bar']}}.
You may provide Jinja2 configuration as plugin options:
plugins:
- markdownextradata:
jinja_options:
comment_start_string: __CUSTOMCOMMENTSTART__The above example will make it so that instead of {#, the template engine will interpret __CUSTOMCOMMENTSTART__ as comment start delimiter. This is useful in cases where
you write Markdown that contains Jinja-like syntax that's colliding with the template engine. Alternatively, it lets you control what the variable delimiter is (instead of the default {{ }}).
virtualenv venv -p python3.7
source venv/bin/activate
python setup.py test
pytest test
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. If you want to contribute to the code of this project, please read the Contribution Guidelines.