# mkdocs-labeled-user-defined-values
This is a plugin for a MkDocs which allows pages to have user defined input values.
The difference with the original mkdocs-user-defined-values is the capability to categorize keywords.
## Setup
Install the plugin using pip:
`pip install mkdocs-labeled-user-defined-values`
Activate the plugin in `mkdocs.yml`:
```yaml
plugins:
- search
- user-defined-values:
input-placeholder: "{{{user-defined-values}}}"
keywords:
cat1:
YOUR_AWS_REGION:
placeholder: e.g. ap-southeast-2
YOUR_AWS_ACCOUNT_ID:
placeholder: e.g. 12355224536
cat2:
ANOTHER_KEYWORD:
label: any label that I want to display
placeholder: e.g. any placeholder that I want to display
```
> **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][mkdocs-plugins].
## 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}}}`.
Please note that appart from `keywords` and *category names* (`cat1` and `cat2` in the above example), most of the parameters are optional.
## 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.
- You can replace *category names* by any name you desire.
## See Also
More information about templates [here][mkdocs-template].
More information about blocks [here][mkdocs-block].
[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables
[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks
Raw data
{
"_id": null,
"home_page": "https://github.com/amazerol/mkdocs-labeled-user-defined-values",
"name": "mkdocs-labeled-user-defined-values",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3, <4",
"maintainer_email": "",
"keywords": "mkdocs plugin multiple user defined value",
"author": "Alban MAZEROLLES",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# mkdocs-labeled-user-defined-values\r\n\r\nThis is a plugin for a MkDocs which allows pages to have user defined input values.\r\n\r\nThe difference with the original mkdocs-user-defined-values is the capability to categorize keywords.\r\n\r\n## Setup\r\n\r\nInstall the plugin using pip:\r\n\r\n`pip install mkdocs-labeled-user-defined-values`\r\n\r\nActivate the plugin in `mkdocs.yml`:\r\n\r\n```yaml\r\nplugins:\r\n - search\r\n - user-defined-values:\r\n input-placeholder: \"{{{user-defined-values}}}\"\r\n keywords:\r\n cat1:\r\n YOUR_AWS_REGION:\r\n placeholder: e.g. ap-southeast-2\r\n YOUR_AWS_ACCOUNT_ID:\r\n placeholder: e.g. 12355224536\r\n cat2:\r\n ANOTHER_KEYWORD:\r\n label: any label that I want to display\r\n placeholder: e.g. any placeholder that I want to display\r\n```\r\n\r\n> **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.\r\n\r\nMore information about plugins in the [MkDocs documentation][mkdocs-plugins].\r\n\r\n## Config\r\n\r\n- `keywords` - This is a list of keywords which you want to allow a user to modify.\r\n- `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}}}`.\r\nPlease note that appart from `keywords` and *category names* (`cat1` and `cat2` in the above example), most of the parameters are optional.\r\n\r\n## Usage\r\n\r\n- Provide a list of `keywords` you want a user to provide dynamically.\r\n- Place `{{{user-defined-values}}}` in your page or template where you want to generate the form for user to provide dynamic values.\r\n- You can replace *category names* by any name you desire.\r\n\r\n## See Also\r\n\r\nMore information about templates [here][mkdocs-template].\r\n\r\nMore information about blocks [here][mkdocs-block].\r\n\r\n[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/\r\n[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables\r\n[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks\r\n",
"bugtrack_url": null,
"license": "",
"summary": "An enhanced version of mkdocs-user-defined-values. Keywords can now be categorized.",
"version": "1.0.5",
"project_urls": {
"Bug Reports": "https://github.com/amazerol/mkdocs-labeled-user-defined-values/issues",
"Homepage": "https://github.com/amazerol/mkdocs-labeled-user-defined-values",
"Source": "https://github.com/amazerol/mkdocs-labeled-user-defined-values/"
},
"split_keywords": [
"mkdocs",
"plugin",
"multiple",
"user",
"defined",
"value"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30b28343faa43bde8f85487b92433450ba77baaddc18672714cf9ee4f75e7589",
"md5": "96468586056d9b89f99d8ca44ead1caf",
"sha256": "8591a8b3dfbb3b76c9610b881e2c448c342fc37bcb58e275b51da91612f0b813"
},
"downloads": -1,
"filename": "mkdocs_labeled_user_defined_values-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96468586056d9b89f99d8ca44ead1caf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3, <4",
"size": 5377,
"upload_time": "2023-07-27T22:10:11",
"upload_time_iso_8601": "2023-07-27T22:10:11.170164Z",
"url": "https://files.pythonhosted.org/packages/30/b2/8343faa43bde8f85487b92433450ba77baaddc18672714cf9ee4f75e7589/mkdocs_labeled_user_defined_values-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-27 22:10:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "amazerol",
"github_project": "mkdocs-labeled-user-defined-values",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mkdocs-labeled-user-defined-values"
}
JSON
