gdtest-mermaid

A package demonstrating Mermaid diagrams

Installation

pip install gdtest-mermaid

Get Started

API Reference — Full API documentation
User Guide — Guides and tutorials

Source files

📁 docs/

📁 user_guide/

📄 01-captions.qmd

---
title: Captions
---

# Mermaid Captions

A wide pipeline flowchart with a cross-referenceable caption
(see @fig-pipeline). It should span the text column, with the caption
underneath.

```{mermaid}
%%| label: fig-pipeline
%%| fig-cap: "The model-fitting pipeline, from raw data to a report."
flowchart LR
  A[Load data] --> B[Validate] --> C[Fit model] --> D[Evaluate] --> E[Report]
  C --> F[Diagnostics] --> D
```

A small diagram with an unlabeled caption keeps its natural size:

```{mermaid}
%%| fig-cap: "A tiny two-node diagram."
flowchart LR
  A --> B
```

A diagram with no caption at all:

```{mermaid}
flowchart TD
  Start --> Decision{OK?}
  Decision -->|Yes| Done
  Decision -->|No| Start
```

📁 gdtest_mermaid/

📄 __init__.py

"""Mermaid diagrams demo package."""

__version__ = "1.0.0"
__all__ = ["greet"]


def greet(name: str) -> str:
    """Return a friendly greeting.

    Parameters
    ----------
    name
        Who to greet.

    Returns
    -------
    str
        The greeting.
    """
    return f"Hello, {name}!"

📄 great-docs.yml

dark_mode: true