https://github.com/stuebersystems/mkdocs-img2fig-plugin

A MkDocs plugin that converts markdown encoded images into <figure> elements.
https://github.com/stuebersystems/mkdocs-img2fig-plugin

mkdocs-plugin

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/stuebersystems/mkdocs-img2fig-plugin
• Owner: stuebersystems
• License: mit
• Created: 2019-05-09T09:48:11.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2022-04-15T06:05:55.000Z (about 3 years ago)
• Last Synced: 2025-03-17T01:51:15.674Z (4 months ago)
• Topics: mkdocs-plugin
• Language: Python
• Homepage: https://pypi.org/project/mkdocs-img2fig-plugin
• Size: 37.1 KB
• Stars: 22
• Watchers: 2
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MkDocs Img2Fig Plugin

This [MkDocs](https://www.mkdocs.org) plugin converts markdown encoded images like

```

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

```

into 

```html

  

  An image caption

```

## Requirements

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

## Installation

Install the package with pip:

```cmd

pip install mkdocs-img2fig-plugin

```

Enable the plugin in your `mkdocs.yml`:

```yaml

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](https://www.mkdocs.org/user-guide/plugins/)