An MkDocs plugin to process configuration items with Jinja2
Project description
mkdocs-jconfig-plugin
This MkDocs plugin allows to process configuration variables using Jinja templates.
Installation
Install the package with pip:
pip install mkdocs-jconfig-plugin
Activate the plugin in mkdocs.yml
:
plugins:
- search
- calendar
- jconfig
Configuration
The plugin can be configured in the plugins
section of mkdocs.yml
as follows:
plugins:
- search
- calendar
- jconfig:
items:
- copyright
The plugin supports the following configuration options:
Option | Description |
---|---|
items |
The configuration variables to process. Defaults to [] . |
Typical usage
This plugin is useful when you want to automatically adjust the year in the copyright:
copyright: copyright {{ cal.today.year }} The Authors
plugins:
- search
- calendar
- jconfig:
items:
- copyright
Note that you need to activate the calendar plugin for this to work.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_jconfig_plugin-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd4a2f57ed1818dcf34ff662a94dae126a342588ecb53f29edcfde0476001893 |
|
MD5 | b431d65ea6dd007a6d65eec7dcd953b3 |
|
BLAKE2b-256 | cc81c0b4f505ba925f5101e8de9087aee67a74df70132e38801c104262cf2d68 |
Close
Hashes for mkdocs_jconfig_plugin-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a4a7c112401bd9692f6eff8a1ed7fa19f904dc41a399c230d403fc9cf763945 |
|
MD5 | 52bf929cb01bfe95013ca3ff913b0740 |
|
BLAKE2b-256 | 999e7714e73b191bfc6c7cfea26e3d5c5a6c21149553d6fc2687eb322f99d4bb |