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:
        YOUR_AWS_REGION:
          placeholder: e.g. ap-southeast-2
        YOUR_AWS_ACCOUNT_ID:
          placeholder: e.g. 12355224536

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

• 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.

Demo/Test

cd demo
pipenv run mkdocs serve

Automated Test

./auto/test

Sync Pipfile.lock -> setup.py

pipenv-setup sync -p -d

Releasing a new version

• Bump version in setup.py
• Sync Pipfile.lock with setup.py pipenv run pipenv-setup sync -p -d
• Create distribution pipenv run python setup.py sdist bdist_wheel
• Check distribution pipenv run twine check dist/*
• Upload distribution pipenv run twine upload dist/* --repository mkdocs-user-defined-values

See Also

More information about templates here.

More information about blocks here.