markdown-img2fig 1.0.1

Convert markdown imgs into captioned <figure>s

Markdown img2fig

Convert inline markdown images to captioned figures.

Inspirated by markdown-captions and yafg.

Installation

pip install markdown-img2fig

Usage

Markdown module

import markdown
import img2fig

data = markdown.markdown(
    md,
    extensions=[
        img2fig.Img2FigExtension(
            source_attr="title",
            remove_attr=True,
            force_convert=True,
            empty_as_none=True,
        ),
        'attr_list',  # optional
    ]
)

MkDocs mkdocs.yml

markdown_extensions:
  - img2fig:
      source_attr: title
      remove_attr: true
      force_convert: true
      empty_as_none: true
  - attr_list # optional

Result

![Alt text](image.jpg "Title text"){: .someclass }

<figure class="someclass">
    <img alt="Alt text" src="image.jpg" />
    <figcaption>Title text</figcaption>
</figure>

Options

• source_attr (default: 'title')
  Use 'title' or 'alt' attribute as the caption.
• remove_attr (default: True)
  Remove the alt/title attribute after conversion.
• force_convert (default: True)
  Convert all images to figures, missing alt/title will cause figures without figcaptions.
  If false, images will be left as is.
• empty_as_none (default: True)
  Treat empty alt/title as if they don't exist.

License

Licensed under the MIT License.