mkdocs-img2fig-plugin-with-icons

Name	mkdocs-img2fig-plugin-with-icons JSON
Version	0.0.2 JSON
	download
home_page	https://github.com/stuebersystems/mkdocs-img2fig-plugin-with-icons
Summary	A MkDocs plugin that converts markdown encoded images into <figure> elements.
upload_time	2023-08-28 06:29:46
maintainer
docs_url	None
author	Antonio Cambule
requires_python	>=3.5
license	MIT
keywords	mkdocs python markdown icons
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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/)



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/stuebersystems/mkdocs-img2fig-plugin-with-icons",
    "name": "mkdocs-img2fig-plugin-with-icons",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "mkdocs python markdown icons",
    "author": "Antonio Cambule",
    "author_email": "antonio.cambule@stueber.de",
    "download_url": "https://files.pythonhosted.org/packages/97/f1/9dec27d1131dd548e4f6a8fb1362a85d10d4702ae0521f5c8d1a390c4403/mkdocs-img2fig-plugin-with-icons-0.0.2.tar.gz",
    "platform": null,
    "description": "# MkDocs Img2Fig Plugin\r\n\r\nThis [MkDocs](https://www.mkdocs.org) plugin converts markdown encoded images like\r\n\r\n```\r\n![An image caption](\\assets\\images\\my-image.png)\r\n```\r\n\r\ninto \r\n\r\n```html\r\n<figure class=\"figure-image\">\r\n  <img src=\"\\assets\\images\\my-image.png\" alt=\"An image caption\">\r\n  <figcaption>An image caption</figcaption>\r\n</figure>\r\n```\r\n\r\n## Requirements\r\n\r\nThis package requires Python >=3.5 and MkDocs version 1.0 or higher.  \r\n\r\n## Installation\r\n\r\nInstall the package with pip:\r\n\r\n```cmd\r\npip install mkdocs-img2fig-plugin\r\n```\r\n\r\nEnable the plugin in your `mkdocs.yml`:\r\n\r\n```yaml\r\nplugins:\r\n    - search\r\n    - img2fig\r\n```\r\n\r\n**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.\r\n\r\nMore information about plugins in the [MkDocs documentation](https://www.mkdocs.org/user-guide/plugins/)\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A MkDocs plugin that converts markdown encoded images into <figure> elements.",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/stuebersystems/mkdocs-img2fig-plugin-with-icons"
    },
    "split_keywords": [
        "mkdocs",
        "python",
        "markdown",
        "icons"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "97f19dec27d1131dd548e4f6a8fb1362a85d10d4702ae0521f5c8d1a390c4403",
                "md5": "be15ae014da2d1b48525c7b3f553b625",
                "sha256": "232724efc80b4322e8be29c31af4182cd4f73e1ced380ce581f2a5bef6b8a2d6"
            },
            "downloads": -1,
            "filename": "mkdocs-img2fig-plugin-with-icons-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "be15ae014da2d1b48525c7b3f553b625",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 2986,
            "upload_time": "2023-08-28T06:29:46",
            "upload_time_iso_8601": "2023-08-28T06:29:46.856587Z",
            "url": "https://files.pythonhosted.org/packages/97/f1/9dec27d1131dd548e4f6a8fb1362a85d10d4702ae0521f5c8d1a390c4403/mkdocs-img2fig-plugin-with-icons-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-28 06:29:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stuebersystems",
    "github_project": "mkdocs-img2fig-plugin-with-icons",
    "github_not_found": true,
    "lcname": "mkdocs-img2fig-plugin-with-icons"
}