mkdocs-drawio-file

Name	mkdocs-drawio-file JSON
Version	1.5.2 JSON
	download
home_page	https://github.com/onixpro/mkdocs-drawio-file/
Summary	Mkdocs plugin that renders .drawio files
upload_time	2023-02-27 23:52:30
maintainer
docs_url	None
author	Sergey Lukin
requires_python	>=3.7.0,<4.0.0
license	MIT
keywords	mkdocs plugin markdown drawio
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MkDocs Plugin for embedding Diagrams.net (Draw.io)
[![](https://github.com/onixpro/mkdocs-drawio-file/workflows/Deploy/badge.svg)](https://github.com/onixpro/mkdocs-drawio-file/actions)
[![PyPI](https://img.shields.io/pypi/v/mkdocs-drawio-file)](https://pypi.org/project/mkdocs-drawio-file/)

[Buy me a 🍜](https://www.buymeacoffee.com/SergeyLukin)

## Features
This plugin enables you to embed interactive drawio diagrams in your documentation. Simple add your files like you would for any other image type:

```markdown
![](my-diagram.drawio)
```

Additionally this plugin supports multi page diagrams by using the `alt` text:

```markdown
![Page-2](my-diagram.drawio)
```

## Setup
Install plugin using pip:

```
pip install mkdocs-drawio-file
```

Add the plugin to your `mkdocs.yml`

```yaml
plugins:
  - drawio_file
```

## How it works

After your mkdocs has generated the HTML for your documentation, the plugin adds the necessary diagram.net javascript library. Searches for `img` tags with a file ending of `*.drawio` and replaces them with the appropiate `mxgraph` html block. For further details, please look at the [official diagrams.net documentation](https://www.diagrams.net/doc/faq/embed-html).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/onixpro/mkdocs-drawio-file/",
    "name": "mkdocs-drawio-file",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7.0,<4.0.0",
    "maintainer_email": "",
    "keywords": "mkdocs,plugin,markdown,drawio",
    "author": "Sergey Lukin",
    "author_email": "onixpro@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/11/a4/ca9d125d2c19e939a491b74c1bc6242a5500752daa36fe39c29f52b3aaf7/mkdocs_drawio_file-1.5.2.tar.gz",
    "platform": null,
    "description": "# MkDocs Plugin for embedding Diagrams.net (Draw.io)\n[![](https://github.com/onixpro/mkdocs-drawio-file/workflows/Deploy/badge.svg)](https://github.com/onixpro/mkdocs-drawio-file/actions)\n[![PyPI](https://img.shields.io/pypi/v/mkdocs-drawio-file)](https://pypi.org/project/mkdocs-drawio-file/)\n\n[Buy me a \ud83c\udf5c](https://www.buymeacoffee.com/SergeyLukin)\n\n## Features\nThis plugin enables you to embed interactive drawio diagrams in your documentation. Simple add your files like you would for any other image type:\n\n```markdown\n![](my-diagram.drawio)\n```\n\nAdditionally this plugin supports multi page diagrams by using the `alt` text:\n\n```markdown\n![Page-2](my-diagram.drawio)\n```\n\n## Setup\nInstall plugin using pip:\n\n```\npip install mkdocs-drawio-file\n```\n\nAdd the plugin to your `mkdocs.yml`\n\n```yaml\nplugins:\n  - drawio_file\n```\n\n## How it works\n\nAfter your mkdocs has generated the HTML for your documentation, the plugin adds the necessary diagram.net javascript library. Searches for `img` tags with a file ending of `*.drawio` and replaces them with the appropiate `mxgraph` html block. For further details, please look at the [official diagrams.net documentation](https://www.diagrams.net/doc/faq/embed-html).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Mkdocs plugin that renders .drawio files",
    "version": "1.5.2",
    "project_urls": {
        "Homepage": "https://github.com/onixpro/mkdocs-drawio-file/",
        "Repository": "https://github.com/onixpro/mkdocs-drawio-file/"
    },
    "split_keywords": [
        "mkdocs",
        "plugin",
        "markdown",
        "drawio"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d7ed3cd599933acfb38b0f7625327e8b0fa3fa369a190f96a49ffa9028ba9807",
                "md5": "c5b7e97b6c57dcac67ea9584388ea265",
                "sha256": "0e87c0c6bcb3ad1e40513b4386d250d7166eb613f3a09e44588f7c572ccb6cad"
            },
            "downloads": -1,
            "filename": "mkdocs_drawio_file-1.5.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c5b7e97b6c57dcac67ea9584388ea265",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.0,<4.0.0",
            "size": 3566,
            "upload_time": "2023-02-27T23:52:29",
            "upload_time_iso_8601": "2023-02-27T23:52:29.389826Z",
            "url": "https://files.pythonhosted.org/packages/d7/ed/3cd599933acfb38b0f7625327e8b0fa3fa369a190f96a49ffa9028ba9807/mkdocs_drawio_file-1.5.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "11a4ca9d125d2c19e939a491b74c1bc6242a5500752daa36fe39c29f52b3aaf7",
                "md5": "5f846f836493e3da3e40a515be0bdec0",
                "sha256": "e4e3da1bdf26ef2731b445320185ae9e8987c2afabd745419f3cdade462d1e11"
            },
            "downloads": -1,
            "filename": "mkdocs_drawio_file-1.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "5f846f836493e3da3e40a515be0bdec0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.0,<4.0.0",
            "size": 2950,
            "upload_time": "2023-02-27T23:52:30",
            "upload_time_iso_8601": "2023-02-27T23:52:30.848103Z",
            "url": "https://files.pythonhosted.org/packages/11/a4/ca9d125d2c19e939a491b74c1bc6242a5500752daa36fe39c29f52b3aaf7/mkdocs_drawio_file-1.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-27 23:52:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "onixpro",
    "github_project": "mkdocs-drawio-file",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-drawio-file"
}