mermaid-magic

Render Mermaid diagrams directly within Google Colab Notebooks using the %%mermaid magic command.

Installation

pip install jupyter-mermaid-cell

Loading the Extension

%load_ext jupyter_mermaid_cell

Basic Usage

%%mermaid
graph TD
    A[Start] --> B[Process]
    B --> C[End]

Example: Flowchart

%%mermaid
flowchart LR
    User --> Application
    Application --> Database
    Database --> Application

Example: Sequence Diagram

%%mermaid
sequenceDiagram
    participant U as User
    participant A as API

    U->>A: Request
    A-->>U: Response

Example: Class Diagram

%%mermaid
classDiagram
    class Animal {
        +name
        +eat()
    }

    class Dog {
        +bark()
    }

    Animal <|-- Dog

Example: GitDiagram

%%mermaid
gitGraph
  commit
  commit
  branch develop
  checkout develop
  commit
  commit
  checkout main
  merge develop
  commit
  commit

Requirements

• Google Colab (or Jupyter Notebook)
• IPython

Acknowledgements

%%mermaid is a wrapper for Google Colab notebooks that enables seamless rendering of Mermaid diagrams.

• Functionality: Simplifies the integration of diagrammatic visualization within Colab environments.
• Reference: This project is inspired by and built upon the original Mermaid.js library.

License

MIT