# mkdocs-jconfig-plugin
This MkDocs plugin allows to process configuration variables using [Jinja](https://jinja.palletsprojects.com/) templates.
## Installation
Install the package with pip:
```bash
pip install mkdocs-jconfig-plugin
```
Activate the plugin in `mkdocs.yml`:
```yaml
plugins:
- search
- calendar
- jconfig
```
## Configuration
The plugin can be configured in the `plugins` section of `mkdocs.yml` as follows:
```yaml
plugins:
- search
- calendar
- jconfig:
items:
- copyright
```
The plugin supports the following configuration options:
| Option | Description |
|---------|-----------------------------------------------------------|
| `items` | The configuration variables to process. Defaults to `[]`. |
## Typical usage
This plugin is useful when you want to automatically adjust the year in the copyright:
```yaml
copyright: copyright {{ cal.today.year }} The Authors
plugins:
- search
- calendar
- jconfig:
items:
- copyright
```
Note that you need to activate the [calendar](https://github.com/supcik/mkdocs-calendar-plugin) plugin for this to work.
Raw data
{
"_id": null,
"home_page": "https://github.com/supcik/mkdocs-jconfig-plugin",
"name": "mkdocs-jconfig-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "mkdocs,python,markdown,wiki",
"author": "Jacques Supcik",
"author_email": "jacques.supcik@hefr.ch",
"download_url": "https://files.pythonhosted.org/packages/8d/4b/b384e49730a0a1fe66f7b9e4bcd84a00e76350267499b57b46c7c4874285/mkdocs_jconfig_plugin-0.1.2.tar.gz",
"platform": null,
"description": "# mkdocs-jconfig-plugin\n\nThis MkDocs plugin allows to process configuration variables using [Jinja](https://jinja.palletsprojects.com/) templates.\n\n## Installation\n\nInstall the package with pip:\n\n```bash\npip install mkdocs-jconfig-plugin\n```\n\nActivate the plugin in `mkdocs.yml`:\n\n```yaml\nplugins:\n - search\n - calendar\n - jconfig\n```\n\n## Configuration\n\nThe plugin can be configured in the `plugins` section of `mkdocs.yml` as follows:\n\n```yaml\nplugins:\n - search\n - calendar\n - jconfig:\n items:\n - copyright\n```\n\nThe plugin supports the following configuration options:\n\n| Option | Description |\n|---------|-----------------------------------------------------------|\n| `items` | The configuration variables to process. Defaults to `[]`. |\n\n## Typical usage\n\nThis plugin is useful when you want to automatically adjust the year in the copyright:\n\n```yaml\ncopyright: copyright {{ cal.today.year }} The Authors\n\nplugins:\n - search\n - calendar\n - jconfig:\n items:\n - copyright\n```\n\nNote that you need to activate the [calendar](https://github.com/supcik/mkdocs-calendar-plugin) plugin for this to work.\n\n",
"bugtrack_url": null,
"license": "Apache-2",
"summary": "An MkDocs plugin to process configuration items with Jinja2",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/supcik/mkdocs-jconfig-plugin",
"Repository": "https://github.com/supcik/mkdocs-jconfig-plugin"
},
"split_keywords": [
"mkdocs",
"python",
"markdown",
"wiki"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1dbdea068db9fe9bfab7fb086fe43379be99e12f6716b0c62ab29d83c73bf79d",
"md5": "182b11d91fbe99abc827d899755ffe83",
"sha256": "6b4b83e07e43299f25c0ee873f5485e338eb855b136053f9c810d6a77218a236"
},
"downloads": -1,
"filename": "mkdocs_jconfig_plugin-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "182b11d91fbe99abc827d899755ffe83",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 3282,
"upload_time": "2023-09-12T11:53:58",
"upload_time_iso_8601": "2023-09-12T11:53:58.364869Z",
"url": "https://files.pythonhosted.org/packages/1d/bd/ea068db9fe9bfab7fb086fe43379be99e12f6716b0c62ab29d83c73bf79d/mkdocs_jconfig_plugin-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d4bb384e49730a0a1fe66f7b9e4bcd84a00e76350267499b57b46c7c4874285",
"md5": "dd55978cd7f48ac64694d37320d808c4",
"sha256": "1725e3d40d5ef1e4814105a8aa8c8b67783ab1ed6dfd9884cb6f09985fce660d"
},
"downloads": -1,
"filename": "mkdocs_jconfig_plugin-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "dd55978cd7f48ac64694d37320d808c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 2692,
"upload_time": "2023-09-12T11:53:59",
"upload_time_iso_8601": "2023-09-12T11:53:59.769389Z",
"url": "https://files.pythonhosted.org/packages/8d/4b/b384e49730a0a1fe66f7b9e4bcd84a00e76350267499b57b46c7c4874285/mkdocs_jconfig_plugin-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-12 11:53:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "supcik",
"github_project": "mkdocs-jconfig-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-jconfig-plugin"
}
JSON
