arterm-sedov / mkdocs-em-img2fig-plugin

An MkDocs plugin that converts markdown encoded images surrounded by single asterisks or underscores into <figure> elements.

MkDocs Em-Img2Fig Plugin

This MkDocs plugin converts markdown encoded images surrounded by two asterisks or two underscores like

*![An image caption](\assets\images\my-image.png)*

OR

_![An image caption](\assets\images\my-image.png)_

into <figure> notation with inline markdown for the image itself:

<figure markdown>
  ![Image caption](\assets\images\my-image.png)
  <figcaption>Image caption</figcaption>
</figure>

Requirements

This package requires:

• Python >=3.9 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

Credits

This plugin is a fork of the https://github.com/stuebersystems/mkdocs-img2fig-plugin which does not require the two asterisks or two underscores