Metadata-Version: 2.4
Name: jupyterlab_mermaid_latest_extension
Version: 1.0.6
Summary: Jupyterlab extension that brings the lates version of the mermaid library to the rendering in notebooks and markdown
Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_mermaid_latest_extension
Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_mermaid_latest_extension/issues
Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_mermaid_latest_extension.git
Author-email: Stellars Henson <konrad.jelen+github@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Stellars Henson
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: jupyter,jupyterlab,jupyterlab-extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: jupyterlab<5,>=4.0.0
Provides-Extra: dev
Requires-Dist: jupyterlab>=4; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# jupyterlab_mermaid_latest_extension

[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_mermaid_latest_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_mermaid_latest_extension/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/jupyterlab_mermaid_latest_extension.svg)](https://www.npmjs.com/package/jupyterlab_mermaid_latest_extension)
[![PyPI version](https://img.shields.io/pypi/v/jupyterlab_mermaid_latest_extension.svg)](https://pypi.org/project/jupyterlab_mermaid_latest_extension/)
[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab_mermaid_latest_extension)](https://pepy.tech/project/jupyterlab_mermaid_latest_extension)
[![JupyterLab 4](https://img.shields.io/badge/JupyterLab-4-orange.svg)](https://jupyterlab.readthedocs.io/en/stable/)
[![Brought To You By KOLOMOLO](https://img.shields.io/badge/Brought%20To%20You%20By-KOLOMOLO-00ffff?style=flat)](https://kolomolo.com)
[![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-blue?style=flat)](https://www.paypal.com/donate/?hosted_button_id=B4KPBJDLLXTSA)

> [!TIP]
> This extension is part of the [stellars_jupyterlab_extensions](https://github.com/stellarshenson/stellars_jupyterlab_extensions) metapackage. Install all Stellars extensions at once: `pip install stellars_jupyterlab_extensions`

JupyterLab extension that brings the latest version of the Mermaid diagram library to notebook and markdown rendering. JupyterLab ships with an older bundled Mermaid version - this extension replaces it with the current release so you get access to the newest diagram types, syntax features, and bug fixes.

> [!WARNING]
> This extension works by monkey-patching the built-in `IMermaidManager` at runtime. It replaces the manager's rendering methods with implementations that use a newer bundled Mermaid library. The built-in Mermaid extension remains loaded but its rendering code is bypassed. This approach may break if JupyterLab changes the `IMermaidManager` interface in a future major release.

## Features

- **Latest Mermaid version** - renders diagrams with Mermaid 11.15.0, independent of JupyterLab 4.5's bundled 11.12.3
- **New diagram types** - access beta and recently stabilised Mermaid diagrams (e.g., `venn-beta`) that the bundled version rejects with `UnknownDiagramError`
- **Transparent replacement** - notebooks, markdown cells, and `.md` files all render through the patched manager
- **Theme aware** - respects JupyterLab dark/light theme and re-renders on theme change

## How It Works

JupyterLab 4 provides an `IMermaidManager` token that all Mermaid rendering flows through. This extension requires that token, then replaces `getMermaid()`, `renderSvg()`, `renderFigure()`, and `getCachedFigure()` with its own implementations backed by a force-bundled newer Mermaid library. Since all consumers (notebook renderer, markdown renderer) hold references to the same manager object, they automatically use the patched methods. The built-in `@jupyterlab/mermaid-extension` stays loaded and enabled - its rendering code is simply bypassed.

## Example

A `venn-beta` diagram, unsupported by JupyterLab's bundled Mermaid, renders with this extension installed:

````markdown
```mermaid
venn-beta
  title "Effects across KPIs"
  set CV
  set ADG
  set FCR
  union CV,ADG,FCR["Temperature uniformity, Feeder access"]
```
````

## Installation

Requires JupyterLab 4.0.0 or higher.

```bash
pip install jupyterlab_mermaid_latest_extension
```

## Uninstall

```bash
pip uninstall jupyterlab_mermaid_latest_extension
```
