mkdocs-jconfig-plugin 0.1.1

An MkDocs plugin to process configuration items with Jinja2

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.