mkdocs-jconfig-plugin

This MkDocs plugin allows to process configuration variables using Jinja templates.

Installation

Install the package with pip:

pip install mkdocs-jconfig-plugin

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - calendar
  - jconfig

Configuration

The plugin can be configured in the plugins section of mkdocs.yml as follows:

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:

copyright: copyright {{ cal.today.year }} The Authors

plugins:
  - search
  - calendar
  - jconfig:
      items:
        - copyright

Note that you need to activate the calendar plugin for this to work.

Metadata

Release files for mkdocs-jconfig-plugin 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-jconfig-plugin 0.1.3
File	Size	Uploaded	Provenance
mkdocs_jconfig_plugin-0.1.3.tar.gz	2.7 kB	Feb 13, 2024	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-jconfig-plugin 0.1.3
File	Interpreter	ABI	Platform	Reset
mkdocs_jconfig_plugin-0.1.3-py3-none-any.whl 3.3 kB Feb 13, 2024 Without provenance	Python 3	none	any	Details

Total release size: 6.0 kB

Release files / mkdocs_jconfig_plugin-0.1.3.tar.gz

Download URL	mkdocs_jconfig_plugin-0.1.3.tar.gz
Size	2.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`fd4a2f57ed1818dcf34ff662a94dae126a342588ecb53f29edcfde0476001893`
BLAKE2b-256 checksum How to use checksums	`cc81c0b4f505ba925f5101e8de9087aee67a74df70132e38801c104262cf2d68`
Upload date	Feb 13, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.2 CPython/3.11.8`

Release files / mkdocs_jconfig_plugin-0.1.3-py3-none-any.whl

Download URL	mkdocs_jconfig_plugin-0.1.3-py3-none-any.whl
Size	3.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7a4a7c112401bd9692f6eff8a1ed7fa19f904dc41a399c230d403fc9cf763945`
BLAKE2b-256 checksum How to use checksums	`999e7714e73b191bfc6c7cfea26e3d5c5a6c21149553d6fc2687eb322f99d4bb`
Upload date	Feb 13, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.2 CPython/3.11.8`

Security for mkdocs-jconfig-plugin 0.1.3

Report project as malware

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.