# MkDocs Em-Img2Fig Plugin
This [MkDocs](https://www.mkdocs.org) plugin converts markdown encoded images surrounded by two asterisks or two underscores like
``` markdown
**
```
OR
``` markdown
__
```
into `<figure>` notation with inline markdown for the image itself:
``` html
<figure markdown>
<figcaption>Image caption</figcaption>
</figure>
```
## Requirements
This package requires:
* Python >=3.9 and MkDocs version 1.0 or higher.
* `md_in_html` extension enabled in your MkDocs configuration.
## Installation
Install the package with pip:
``` cmd
pip install mkdocs-em-img2fig-plugin
```
Enable the mkdocs-em-img2fig-plugin plugin and md_in_html extension in your `mkdocs.yml`:
``` yaml
plugins:
- search
- autolinks
- em-img2fig
markdown_extensions:
- md_in_html
```
**Note:** If you use autolinks or similar plugin declare em-img2fig after it, not before for correct precedence.
**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/)
## Credits
This plugin is a fork of the https://github.com/stuebersystems/mkdocs-img2fig-plugin which does not require the two asterisks or two underscores
Raw data
{
"_id": null,
"home_page": "https://github.com/arterm-sedov/mkdocs-em-img2fig-plugin",
"name": "mkdocs-em-img2fig-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "mkdocs python markdown",
"author": "Arterm Sedov",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c3/c2/b9fb25de4b8bba7c186a5bd2c6af8a3a4ac36b4e627a52c1d4765ab23dc2/mkdocs_em_img2fig_plugin-0.3.3.tar.gz",
"platform": null,
"description": "# MkDocs Em-Img2Fig Plugin\r\n\r\nThis [MkDocs](https://www.mkdocs.org) plugin converts markdown encoded images surrounded by two asterisks or two underscores like\r\n\r\n``` markdown\r\n**\r\n```\r\nOR\r\n``` markdown\r\n__\r\n\r\n```\r\n\r\ninto `<figure>` notation with inline markdown for the image itself:\r\n\r\n``` html\r\n<figure markdown>\r\n \r\n <figcaption>Image caption</figcaption>\r\n</figure>\r\n```\r\n\r\n## Requirements\r\n\r\nThis package requires:\r\n* Python >=3.9 and MkDocs version 1.0 or higher. \r\n* `md_in_html` extension enabled in your MkDocs configuration.\r\n\r\n## Installation\r\n\r\nInstall the package with pip:\r\n \r\n``` cmd\r\npip install mkdocs-em-img2fig-plugin\r\n```\r\n\r\nEnable the mkdocs-em-img2fig-plugin plugin and md_in_html extension in your `mkdocs.yml`:\r\n\r\n``` yaml\r\nplugins:\r\n - search\r\n - autolinks\r\n - em-img2fig\r\nmarkdown_extensions:\r\n - md_in_html\r\n```\r\n**Note:** If you use autolinks or similar plugin declare em-img2fig after it, not before for correct precedence.\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## Credits\r\nThis plugin is a fork of the https://github.com/stuebersystems/mkdocs-img2fig-plugin which does not require the two asterisks or two underscores\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A MkDocs plugin that converts markdown encoded images surrounded by two asterisks or two underscores into <figure> elements.",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/arterm-sedov/mkdocs-em-img2fig-plugin"
},
"split_keywords": [
"mkdocs",
"python",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "12ea6c9ffb768bdf67d76c5174a917fbc7b5d0a7cf3f5a117d97ef3b0acc0d7f",
"md5": "15eca75063d82805b9319288cdfba871",
"sha256": "d1e7c47a6dbee2256bbaade097194b3675a40bbd968331c604f39f328193ffcf"
},
"downloads": -1,
"filename": "mkdocs_em_img2fig_plugin-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15eca75063d82805b9319288cdfba871",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3776,
"upload_time": "2024-08-28T15:18:20",
"upload_time_iso_8601": "2024-08-28T15:18:20.058765Z",
"url": "https://files.pythonhosted.org/packages/12/ea/6c9ffb768bdf67d76c5174a917fbc7b5d0a7cf3f5a117d97ef3b0acc0d7f/mkdocs_em_img2fig_plugin-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c3c2b9fb25de4b8bba7c186a5bd2c6af8a3a4ac36b4e627a52c1d4765ab23dc2",
"md5": "a553ea9d22b9bb3f3c007f99e50b536c",
"sha256": "8780fa24d5f99b6e5c1649dff113b69c1c4eefdf40b2ccd19b6025334a3ec9af"
},
"downloads": -1,
"filename": "mkdocs_em_img2fig_plugin-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "a553ea9d22b9bb3f3c007f99e50b536c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4145,
"upload_time": "2024-08-28T15:18:21",
"upload_time_iso_8601": "2024-08-28T15:18:21.247088Z",
"url": "https://files.pythonhosted.org/packages/c3/c2/b9fb25de4b8bba7c186a5bd2c6af8a3a4ac36b4e627a52c1d4765ab23dc2/mkdocs_em_img2fig_plugin-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 15:18:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arterm-sedov",
"github_project": "mkdocs-em-img2fig-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-em-img2fig-plugin"
}
JSON
