mkdocs-izsam-mermaid-to-images

Name	mkdocs-izsam-mermaid-to-images JSON
Version	1.1 JSON
	download
home_page	None
Summary	MkDocs plugin to convert Mermaid code blocks to images.
upload_time	2024-09-17 09:21:15
maintainer	None
docs_url	None
author	Alessandro De Luca
requires_python	>=3.8
license	MIT
keywords	mkdocs mermaid mermaid to images
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MkDocs IZSAM Mermaid to images

This plugin processes each page's Markdown content, finds Mermaid code blocks, converts them to images using `mermaid.cli`, and replaces the code blocks with image references. The image format can be specified in the `mkdocs.yml` configuration file.

## Installation

Install dependencies:

```bash
npm install -g @mermaid-js/mermaid-cli
```

Install the package with pip:

```bash
pip install mkdocs-izsam-mermaid-to-images
```

Enable the plugin in the `mkdocs.yml` file:

```yaml
plugins:
  - search
  - mkdocs-izsam-mermaid-to-images:
      output_dir: 'mermaid_images'
      image_format: 'svg'  # or 'png'
```

> See how to use [MkDocs Plugins](https://www.mkdocs.org/dev-guide/plugins/#using-plugins)

# Change log

## [1.0.1] - 2024-09-17

### Setup bug fix and README changes
Bug fix for setup entry_points section; fix for error in configuration instructions.

## [1.0] - 2024-09-17

### First release



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-izsam-mermaid-to-images",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "MkDocs, Mermaid, Mermaid to images",
    "author": "Alessandro De Luca",
    "author_email": "al.deluca@izs.it",
    "download_url": "https://files.pythonhosted.org/packages/77/e8/8f3038f73e5a4d4c69146997365df87c3939f612e993a30dde7964809db9/mkdocs-izsam-mermaid-to-images-1.1.tar.gz",
    "platform": null,
    "description": "# MkDocs IZSAM Mermaid to images\n\nThis plugin processes each page's Markdown content, finds Mermaid code blocks, converts them to images using `mermaid.cli`, and replaces the code blocks with image references. The image format can be specified in the `mkdocs.yml` configuration file.\n\n## Installation\n\nInstall dependencies:\n\n```bash\nnpm install -g @mermaid-js/mermaid-cli\n```\n\nInstall the package with pip:\n\n```bash\npip install mkdocs-izsam-mermaid-to-images\n```\n\nEnable the plugin in the `mkdocs.yml` file:\n\n```yaml\nplugins:\n  - search\n  - mkdocs-izsam-mermaid-to-images:\n      output_dir: 'mermaid_images'\n      image_format: 'svg'  # or 'png'\n```\n\n> See how to use [MkDocs Plugins](https://www.mkdocs.org/dev-guide/plugins/#using-plugins)\n\n# Change log\n\n## [1.0.1] - 2024-09-17\n\n### Setup bug fix and README changes\nBug fix for setup entry_points section; fix for error in configuration instructions.\n\n## [1.0] - 2024-09-17\n\n### First release\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "MkDocs plugin to convert Mermaid code blocks to images.",
    "version": "1.1",
    "project_urls": null,
    "split_keywords": [
        "mkdocs",
        " mermaid",
        " mermaid to images"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d33b046dd1cce3ddc1583d7297d6442580d5b1df4f037f20225e552ca0c58fa8",
                "md5": "21528b56c3ca8a7f59cf492b78849275",
                "sha256": "9a940f44caa09f1781ad9b7887eaf2cf31e21018b335ba0697e14360ec758614"
            },
            "downloads": -1,
            "filename": "mkdocs_izsam_mermaid_to_images-1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "21528b56c3ca8a7f59cf492b78849275",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4291,
            "upload_time": "2024-09-17T09:21:12",
            "upload_time_iso_8601": "2024-09-17T09:21:12.363181Z",
            "url": "https://files.pythonhosted.org/packages/d3/3b/046dd1cce3ddc1583d7297d6442580d5b1df4f037f20225e552ca0c58fa8/mkdocs_izsam_mermaid_to_images-1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "77e88f3038f73e5a4d4c69146997365df87c3939f612e993a30dde7964809db9",
                "md5": "46f90d27f2105f5c1ae132c46aa55c25",
                "sha256": "b0fd97c060ec8dc11c81c0e5e2a4b2281745ff359e5de2b2bb854efde532f037"
            },
            "downloads": -1,
            "filename": "mkdocs-izsam-mermaid-to-images-1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "46f90d27f2105f5c1ae132c46aa55c25",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 3155,
            "upload_time": "2024-09-17T09:21:15",
            "upload_time_iso_8601": "2024-09-17T09:21:15.130682Z",
            "url": "https://files.pythonhosted.org/packages/77/e8/8f3038f73e5a4d4c69146997365df87c3939f612e993a30dde7964809db9/mkdocs-izsam-mermaid-to-images-1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-17 09:21:15",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mkdocs-izsam-mermaid-to-images"
}