---
name: shypermaid
description: >
  Shiny for Python app-package that renders Mermaid diagrams. Use when writing Python code that uses the shypermaid package.
compatibility: Requires Python >=3.10.
---

# shypermaid

Shiny for Python app-package that renders Mermaid diagrams

## Installation

```bash
pip install shypermaid
```

## API overview

### App

Assemble and launch the full app

- `create_app`: Create the Shiny app and serve ``www/`` at ``/shypermaid``
- `run_app`: Launch the app and open it in a browser

### Modules

Shiny Core modules for embedding the editor and viewer in another app

- `editor_ui`
- `editor_server`
- `viewer_ui`
- `viewer_server`

### Diagram helpers

Shiny free functions that prepare Mermaid code and render options

- `set_direction`: Rewrite the direction of a flowchart, state, class, or git graph diagram
- `render_config`: Build the options passed to ``mermaid.initialize()``

## Resources

- [Full documentation](https://mjfrigaard.github.io/shypermaid/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs
