mkdocs-img2fig-plugin

Name	mkdocs-img2fig-plugin JSON
Version	0.9.3 JSON
	download
home_page	https://github.com/stuebersystems/mkdocs-img2fig-plugin
Summary	A MkDocs plugin that converts markdown encoded images into <figure> elements.
upload_time	2020-07-14 09:46:39
maintainer
docs_url	None
author	Antonio Cambule
requires_python	>=3.5
license	MIT
keywords	mkdocs python markdown
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",
    "name": "mkdocs-img2fig-plugin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "mkdocs python markdown",
    "author": "Antonio Cambule",
    "author_email": "antonio.cambule@stueber.de",
    "download_url": "https://files.pythonhosted.org/packages/02/7f/8e3b711fec74c15b0969dd0cfb9314ba2e970d5226ca3fc12e508cdcfd4a/mkdocs-img2fig-plugin-0.9.3.tar.gz",
    "platform": "",
    "description": "# MkDocs Img2Fig Plugin\n\nThis [MkDocs](https://www.mkdocs.org) plugin converts markdown encoded images like\n\n```\n![An image caption](\\assets\\images\\my-image.png)\n```\n\ninto \n\n```html\n<figure class=\"figure-image\">\n  <img src=\"\\assets\\images\\my-image.png\" alt=\"An image caption\">\n  <figcaption>An image caption</figcaption>\n</figure>\n```\n\n## Requirements\n\nThis package requires Python >=3.5 and MkDocs version 1.0 or higher.  \n\n## Installation\n\nInstall the package with pip:\n\n```cmd\npip install mkdocs-img2fig-plugin\n```\n\nEnable the plugin in your `mkdocs.yml`:\n\n```yaml\nplugins:\n    - search\n    - img2fig\n```\n\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.\n\nMore information about plugins in the [MkDocs documentation](https://www.mkdocs.org/user-guide/plugins/)",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A MkDocs plugin that converts markdown encoded images into <figure> elements.",
    "version": "0.9.3",
    "project_urls": {
        "Homepage": "https://github.com/stuebersystems/mkdocs-img2fig-plugin"
    },
    "split_keywords": [
        "mkdocs",
        "python",
        "markdown"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "027f8e3b711fec74c15b0969dd0cfb9314ba2e970d5226ca3fc12e508cdcfd4a",
                "md5": "2ac2a628064bdc485d7084ce562a3778",
                "sha256": "61399d71bb85525d74b1b9435dc6cea747c1af4eff1eb766b98b5605bb78fe4f"
            },
            "downloads": -1,
            "filename": "mkdocs-img2fig-plugin-0.9.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2ac2a628064bdc485d7084ce562a3778",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 3030,
            "upload_time": "2020-07-14T09:46:39",
            "upload_time_iso_8601": "2020-07-14T09:46:39.616128Z",
            "url": "https://files.pythonhosted.org/packages/02/7f/8e3b711fec74c15b0969dd0cfb9314ba2e970d5226ca3fc12e508cdcfd4a/mkdocs-img2fig-plugin-0.9.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-07-14 09:46:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stuebersystems",
    "github_project": "mkdocs-img2fig-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-img2fig-plugin"
}