Links
AI / Agents
gdtest-d2-diagrams
A package demonstrating build-time D2 diagrams
Installation
pip install gdtest-d2-diagramsGet Started
- API Reference — Full API documentation
- User Guide — Guides and tutorials
Source files
gdtest_d2_diagrams/
__init__.py
"""D2 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}!"user_guide/
01-basic.qmd
---
title: Basic Diagram
---
# 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
```02-options.qmd
---
title: Diagram Options
---
# 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
```03-sequence.qmd
---
title: Sequence Diagram
---
# 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
```great-docs.yml
dark_mode: true