mermaid-nb 0.0.2

No project description provided

mermaid-nb

Create Mermaid diagrams in Python

Installation

pip install mermaid-nb

or with uv:

uv add mermaid-nb

Getting Started

In your notebook, run the following command:

from mermaid_nb import Mermaid

Mermaid(diagram="flowchart LR\n  Hello --> World\n  Hello --> Name")

Create a Mermaid diagram in a Jupyter notebook

Create a Mermaid diagram in a marimo notebook or a marimo WebAssembly (WASM) notebook

Here is a basic example of a marimo WebAssembly (WASM) notebook.

Create a Mermaid diagram in a JupyterLite notebook

Here is a basic example of a JupyterLite notebook.

Development

We recommend using uv for development. It will automatically manage virtual environments and dependencies for you.

uv run jupyter lab example.ipynb

Alternatively, create and manage your own virtual environment:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab example.ipynb

Open example.ipynb in JupyterLab, VS Code, or your favorite editor to start developing. Changes made in src/mermaid_nb/static/ will be reflected in the notebook.