mkdocs-image-captions

Name	mkdocs-image-captions JSON
Version	0.2.2 JSON
	download
home_page
Summary	MkDocs plugin that added captions to images by converting markdown encoded images into <figure> elements.
upload_time	2023-03-23 14:32:21
maintainer
docs_url	None
author	Andrii Babenko
requires_python	>=3.7,<4.0
license	MIT
keywords	mkdocs
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MkDocs ImageCaptions Plugin

Plugin for [MkDocs](https://www.mkdocs.org) that converts markdown encoded images to HTML <figure> element with captions.

## Example

Input MD Template:

```
![Informative image caption](/docs/assets/images/image.png)
```

Output:

```html
<figure class="figure-image">
  <img src="/docs/assets/images/image.png" alt="Informative image caption">
  <figcaption>Informative image caption</figcaption>
</figure>
```

## Plugin installation


To enable the plugin, add the following line to your `mkdocs` config file `mkdocs.yml`:

```yaml
plugins:
    - mkdocs-image-captions
```

## Local development

### Dependencies installation

The package requires Python >= 3.8 and Poetry >= 1.4.0.  

### Project installation

Install required packages 

```
poetry install
```

Now you can activate Poetry and make your changes:

```
poetry shell
```

### Run tests

Activate virtualenv:

```
poetry shell
```

Run tests:

```
python tests/test_plugin.py
```

### Update package on PyPI with poetry

Build new package version

```
poetry build
```

Push to PyPI

```
poetry publish
```

**Note:** to push packages into PyPI you need to provide auth token:

```
export POETRY_PYPI_TOKEN_PYPI=<your token>
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mkdocs-image-captions",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "mkdocs",
    "author": "Andrii Babenko",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/33/2e/e3dba8299645c26ec3d1bf0d03923cb8af8dbafa7f1df3e640ed7e937ca9/mkdocs_image_captions-0.2.2.tar.gz",
    "platform": null,
    "description": "# MkDocs ImageCaptions Plugin\n\nPlugin for [MkDocs](https://www.mkdocs.org) that converts markdown encoded images to HTML <figure> element with captions.\n\n## Example\n\nInput MD Template:\n\n```\n![Informative image caption](/docs/assets/images/image.png)\n```\n\nOutput:\n\n```html\n<figure class=\"figure-image\">\n  <img src=\"/docs/assets/images/image.png\" alt=\"Informative image caption\">\n  <figcaption>Informative image caption</figcaption>\n</figure>\n```\n\n## Plugin installation\n\n\nTo enable the plugin, add the following line to your `mkdocs` config file `mkdocs.yml`:\n\n```yaml\nplugins:\n    - mkdocs-image-captions\n```\n\n## Local development\n\n### Dependencies installation\n\nThe package requires Python >= 3.8 and Poetry >= 1.4.0.  \n\n### Project installation\n\nInstall required packages \n\n```\npoetry install\n```\n\nNow you can activate Poetry and make your changes:\n\n```\npoetry shell\n```\n\n### Run tests\n\nActivate virtualenv:\n\n```\npoetry shell\n```\n\nRun tests:\n\n```\npython tests/test_plugin.py\n```\n\n### Update package on PyPI with poetry\n\nBuild new package version\n\n```\npoetry build\n```\n\nPush to PyPI\n\n```\npoetry publish\n```\n\n**Note:** to push packages into PyPI you need to provide auth token:\n\n```\nexport POETRY_PYPI_TOKEN_PYPI=<your token>\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "MkDocs plugin that added captions to images by converting markdown encoded images into <figure> elements.",
    "version": "0.2.2",
    "split_keywords": [
        "mkdocs"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "69675876ddb8adb5970263321eca44df50fb136bf515d045d73ad246f5ea852d",
                "md5": "d3b94696b568bda2382a2e5a304285d6",
                "sha256": "8867055382955d5cb9047c3638662e3f190487c86bc09bd2932050765e9f8aff"
            },
            "downloads": -1,
            "filename": "mkdocs_image_captions-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d3b94696b568bda2382a2e5a304285d6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 3980,
            "upload_time": "2023-03-23T14:32:19",
            "upload_time_iso_8601": "2023-03-23T14:32:19.575296Z",
            "url": "https://files.pythonhosted.org/packages/69/67/5876ddb8adb5970263321eca44df50fb136bf515d045d73ad246f5ea852d/mkdocs_image_captions-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "332ee3dba8299645c26ec3d1bf0d03923cb8af8dbafa7f1df3e640ed7e937ca9",
                "md5": "d9a8c221377c7d3a6baf6b46cacdddd1",
                "sha256": "10f70c801e55451886f6317d7c7bf7ce9c509dfd171a4445a1ee9b80826d9fd0"
            },
            "downloads": -1,
            "filename": "mkdocs_image_captions-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "d9a8c221377c7d3a6baf6b46cacdddd1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 2931,
            "upload_time": "2023-03-23T14:32:21",
            "upload_time_iso_8601": "2023-03-23T14:32:21.349221Z",
            "url": "https://files.pythonhosted.org/packages/33/2e/e3dba8299645c26ec3d1bf0d03923cb8af8dbafa7f1df3e640ed7e937ca9/mkdocs_image_captions-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-23 14:32:21",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "mkdocs-image-captions"
}