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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d49887ed956998e133a1c7b10744d27c07b94b7e1cd205f97f89ddda8c661a4 |
|
MD5 | 01d7bfb7e7a13e36a9c1f9a1ede3c7c4 |
|
BLAKE2b-256 | aebeeacd1d73a817bdf6ff8cfd64ac83cd6b766f64386e8d39c6f807e528f642 |
Close
Hashes for mkdocs_image_captions-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5790e9006b8ea8927b28a56476421403a52e7fc58ed4a49034491657fc00fc31 |
|
MD5 | 2336fc0f9c6e1daa1111a5a9f0d93f0c |
|
BLAKE2b-256 | 0902e0606378ff5215633518be61da8367bf398219d098e1b4cf890fee11a317 |