mkdocs-plugin-template

This is a template for a MkDocs plugin.

Setup

Install the plugin using pip:

pip install mkdocs-your-plugin-name

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - your-plugin-name

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.

Config

• param - This does something

Usage

See Also

More information about templates here.

More information about blocks here.