MkDocs ImageCaptions Plugin

Plugin for MkDocs that converts markdown encoded images to HTML

element with captions.

Example

Input MD Template:

![Informative image caption](/docs/assets/images/image.png)

Output:

<figure class="figure-image">
  <img src="/docs/assets/images/image.png" alt="Informative image caption">
  <figcaption>Informative image caption</figcaption>
</figure>

Plugin installation

To enable the plugin, add the following line to your mkdocs config file mkdocs.yml:

plugins:
    - mkdocs-image-captions

Local development

Dependencies installation

The package requires Python >= 3.8 and Poetry >= 1.4.0.

Project installation

Install required packages

poetry install

Now you can activate Poetry and make your changes:

poetry shell

Run tests

Activate virtualenv:

poetry shell

Run tests:

python tests/test_plugin.py

Update package on PyPI with poetry

Build new package version

poetry build

Push to PyPI

poetry publish

Note: to push packages into PyPI you need to provide auth token:

export POETRY_PYPI_TOKEN_PYPI=<your token>

Metadata

Release files for mkdocs-image-captions 0.2.2

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-image-captions 0.2.2
File	Size	Uploaded	Provenance
mkdocs_image_captions-0.2.2.tar.gz	2.9 kB	Mar 23, 2023	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-image-captions 0.2.2
File	Interpreter	ABI	Platform	Reset
mkdocs_image_captions-0.2.2-py3-none-any.whl 4.0 kB Mar 23, 2023 Without provenance	Python 3	none	any	Details

Total release size: 6.9 kB

Release files / mkdocs_image_captions-0.2.2.tar.gz

Download URL	mkdocs_image_captions-0.2.2.tar.gz
Size	2.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`10f70c801e55451886f6317d7c7bf7ce9c509dfd171a4445a1ee9b80826d9fd0`
BLAKE2b-256 checksum How to use checksums	`332ee3dba8299645c26ec3d1bf0d03923cb8af8dbafa7f1df3e640ed7e937ca9`
Upload date	Mar 23, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.4.1 CPython/3.8.16 Darwin/20.4.0`

Release files / mkdocs_image_captions-0.2.2-py3-none-any.whl

Download URL	mkdocs_image_captions-0.2.2-py3-none-any.whl
Size	4.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8867055382955d5cb9047c3638662e3f190487c86bc09bd2932050765e9f8aff`
BLAKE2b-256 checksum How to use checksums	`69675876ddb8adb5970263321eca44df50fb136bf515d045d73ad246f5ea852d`
Upload date	Mar 23, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.4.1 CPython/3.8.16 Darwin/20.4.0`

Security for mkdocs-image-captions 0.2.2

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.