A MkDocs plugin that converts markdown encoded images surrounded by two asterisks into <figure> elements.
Project description
MkDocs Em-Img2Fig Plugin
This MkDocs plugin converts markdown encoded images surrounded by two asterisks like
*![An image caption](\assets\images\my-image.png)*
into <figure>
notation with inline markdown for the image itself:
<figure markdown>
![An image caption](\assets\images\my-image.png)
<figcaption>An image caption</figcaption>
</figure>
Credits
This plugin is a fork of the https://github.com/stuebersystems/mkdocs-img2fig-plugin which does not require the two asterisks
Requirements
This package requires:
- Python >=3.5 and MkDocs version 1.0 or higher.
md_in_html
extension enabled in your MkDocs configuration.
Installation
Install the package with pip:
pip install mkdocs-em-img2fig-plugin
Enable the plugin in your mkdocs.yml
:
plugins:
- search
- autolinks
- em-img2fig
Note: If you use autolinks or similar plugin declare em-img2fig after it, not before for correct precedence.
Note: If you have no plugins
entry in your config file yet, you'll likely also want to add the search
plugin. MkDocs enables it by default if there is no plugins
entry set, but now you have to enable it explicitly.
More information about plugins in the MkDocs documentation
Project details
Release history Release notifications | RSS feed
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
Hashes for mkdocs-em-img2fig-plugin-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e214724a02218b58db6dbd41dc3f86e86dbd78185f7d894aad20e0881adafc4f |
|
MD5 | 453b7a90a9ce5e11a5aa5d04a4271d16 |
|
BLAKE2b-256 | 742cf8650b0702f03b20eeeb4fd6a61c10968bb1ef915d6f4f29b0fd23bfc5e7 |
Hashes for mkdocs_em_img2fig_plugin-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdbb0462c86702e9720f8e24ada72d835c0a0e742b34ae84f9172a5dd5da9faf |
|
MD5 | 89e123dba4ed0eb1b88827af63d2645c |
|
BLAKE2b-256 | 56869d7a797955443ceb08d60847ec2a929dba5068d9f3608385509c52cdd001 |