Enable user defined values for MkDocs
Project description
mkdocs-user-defined-values
This is a plugin for a MkDocs which allows pages to have user defined input values.
Setup
Install the plugin using pip:
pip install mkdocs-user-defined-values
Activate the plugin in mkdocs.yml
:
plugins:
- search
- user-defined-values:
keywords:
- DOC_AS_CODE_PATH
- DOC_AS_CODE_VERSION
Note: If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set, but now you have to enable it explicitly.
More information about plugins in the MkDocs documentation.
Config
keywords
- This is a list of keywords which you want to allow a user to modify.input-placeholder
- This is a placeholder where you want the plugin to generate the form for user to provide dynamic values for each keyword. Default value is{{{user-defined_values}}}
.
Usage
- Provide a list of
keywords
you want a user to provide dynamically. - Place
{{{user-defined_values}}}
in your page or template where you want to generate the form for user to provide dynamic values.
See Also
More information about templates here.
More information about blocks here.
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
Close
Hashes for mkdocs-user-defined-values-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43d64870b9d7f472e32f0e1a38683da3b4eb2296e355d63924b53de5bca365a8 |
|
MD5 | 516740267aff832dfc41b04b91c4a52f |
|
BLAKE2b-256 | e38eed4ce5ed997578db536b9c807bd59402ac8324058fb3040d986fc2cba183 |