Metadata-Version: 2.4
Name: jupyter-mermaid-cell
Version: 0.1.3
Summary: Magic cell para ejecutar Mermaid de forma interactiva en Jupyter y Colab
Project-URL: Homepage, https://github.com/mgarcesdev/mermaid-magic
Author-email: Manuel <manuegp1994@gmail.com>
Classifier: Framework :: IPython
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: ipython>=7.0.0
Requires-Dist: traitlets>=5.0.0
Description-Content-Type: text/markdown

# mermaid-magic

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

## Installation

```bash
pip install jupyter-mermaid-cell
```

## Loading the Extension

```python
%load_ext jupyter_mermaid_cell
```

## Basic Usage

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

## Example: Flowchart

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

## Example: Sequence Diagram

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

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

## Example: Class Diagram

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

    class Dog {
        +bark()
    }

    Animal <|-- Dog
```

## Example: GitDiagram

```python
%%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](https://github.com/mermaid-js/mermaid).

## License

MIT
