----------------------------------------------------------------------
This is the API documentation for the gdtest_d2_diagrams library.
----------------------------------------------------------------------


## Functions

Public functions


greet(name: str) -> str

Return a friendly greeting.

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

Returns
-------
str
    The greeting.


----------------------------------------------------------------------
This is the User Guide documentation for the package.
----------------------------------------------------------------------

# Basic D2 Flowchart

A simple decision flow, pre-rendered to light and dark SVGs at build time.

```{d2}
Start -> Decision
Decision -> Action: Yes
Decision -> End: No
```


# D2 Options

A hand-drawn (sketch) diagram using the ELK layout engine, configured with
`#|` option lines that are stripped before rendering.

```{d2}
#| sketch: true
#| layout: elk
#| pad: 40
Idea -> Draft -> Review -> Publish
```


# D2 Sequence Diagram

Sequence diagrams use the same syntax with `shape: sequence_diagram`.

```{d2}
shape: sequence_diagram
User -> CLI: great-docs build
CLI -> Core: build()
Core -> User: site ready
```

The plain ```` ```d2 ```` fence (no braces) is also recognized:

```d2
x -> y -> z
```