MkDocs plugin that added captions to images by converting markdown encoded images into <figure> elements.
Project description
MkDocs ImageCaptions Plugin
Plugin for MkDocs that converts markdown encoded images to HTML
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_image_captions-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f65101879bf9a9b074bb955c6f58929e2fe6a3847c662dd5cbe30dda5c7bee70 |
|
MD5 | aad6480d0ec7e0fccd48e427e4421b56 |
|
BLAKE2b-256 | 6dcd0f11b5892e5cf66de153c06cba7b75fdc86fb9b8b1883bf1a74b2c5fe5fe |
Close
Hashes for mkdocs_image_captions-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfb32561557543c96a00c0631fcafe0834bdd1093283e1f1a23a17a5efb0f8ea |
|
MD5 | 859dfcde2546e9f9bf726bd9efcb098f |
|
BLAKE2b-256 | a289a517745a61632936a6f1f40f3f14e90d08e19772386b18a43b7873a9626f |