stuebersystems / mkdocs-img2fig-plugin

A MkDocs plugin that converts markdown encoded images into <figure> elements.

MkDocs Img2Fig Plugin

This MkDocs plugin converts markdown encoded images like

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

into

<figure class="figure-image">
  <img src="\assets\images\my-image.png" alt="An image caption">
  <figcaption>An image caption</figcaption>
</figure>

Requirements

This package requires Python >=3.5 and MkDocs version 1.0 or higher.

Installation

Install the package with pip:

pip install mkdocs-img2fig-plugin

Enable the plugin in your mkdocs.yml:

plugins:
    - search
    - img2fig

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