Metadata-Version: 2.1
Name: mkdocs-img2fig-plugin
Version: 0.9.3
Summary: A MkDocs plugin that converts markdown encoded images into <figure> elements.
Home-page: https://github.com/stuebersystems/mkdocs-img2fig-plugin
Author: Antonio Cambule
Author-email: antonio.cambule@stueber.de
License: MIT
Description: # 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
        <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:
        
        ```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/)
        
Keywords: mkdocs python markdown
Platform: UNKNOWN
Requires-Python: >=3.5
Description-Content-Type: text/markdown
