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
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry 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
keywordsyou 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
Releasing a new version
- Bump version in setup.py
- Create distribution
pipenv run python setup.py 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.
Metadata
Release files for mkdocs-user-defined-values 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_user_defined_values-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_user_defined_values-0.0.5-py3-none-any.whl |
Release files / mkdocs_user_defined_values-0.0.5-py3-none-any.whl
| Download URL | mkdocs_user_defined_values-0.0.5-py3-none-any.whl |
|---|---|
| Size | 3.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
73fc60c19e5ba20aeaa2c83cea155dda8dd298ff75d748165a39bada721b2717
|
|
BLAKE2b-256 checksum How to use checksums |
6e6d87863549ec07371ad0c36e53f1ae39b595f93d7bdc776a20fdc0becee23d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.7
|
Security for mkdocs-user-defined-values 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.