Skip to main content

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

Project description

MkDocs Img2Fig v3 Plugin

this project fix bug and add new feature in MkDocs Img2Fig plugin

This MkDocs plugin converts markdown encoded images like

![An image caption](../images/my-image.png){align="right" width="20%"}

into

<figure class="figure-image">
  <img src="../../images/my-image.png" alt="An image caption" align="left" width="20%" >
  <figcaption>An image caption</figcaption>
</figure>

center image

unfortunately, align:center is not supported. if you want to center image, add style="display:block; margin:0 auto;

for example

![An image caption](../images/my-image.png){width="20%" style="display:block; margin:0 auto;"}

Requirements

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

Installation

Install the package with pip:

pip install mkdocs-img2figv3-plugin

Enable the plugin in your mkdocs.yml:

plugins:
    - search
    - img2figv3

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

This plugin also fixed the known issue in mkdocs-img2figv2-plugin. It now works with use_directory_urls: false in mkdocs.yml.

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

mkdocs-img2figv3-plugin-0.0.2.tar.gz (3.5 kB view details)

Uploaded Source

File details

Details for the file mkdocs-img2figv3-plugin-0.0.2.tar.gz.

File metadata

File hashes

Hashes for mkdocs-img2figv3-plugin-0.0.2.tar.gz
Algorithm Hash digest
SHA256 d9e2b8fccba17d0279ad320952c1269480f20be08075ea65ca29fc3116158292
MD5 fc1c4d6f02db340b970bb626e5bae05e
BLAKE2b-256 53b560b6427f8e02ed5be0966b55a85636d1f9e98c57fd77a3e0ee5bcd4fc2e2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page