Skip to main content

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

Project description

MkDocs Img2Fig Plugin

This MkDocs plugin converts markdown encoded images like

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


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


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


Install the package with pip:

pip install mkdocs-img2fig-plugin

Enable the plugin in your mkdocs.yml:

    - 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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-img2fig-plugin, version 0.9.3
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs-img2fig-plugin-0.9.3.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page