# Markdy

> Open-source diagram-native DSL for animated architecture and system diagrams — write semantic nodes, groups, beats, flows, and cues to get browser-native motion diagrams.

MarkdyScript is the language used by Markdy. It declares scenes, semantic architecture nodes, groups, beats, flow operators, and cues for animated technical diagrams.

## Authoritative Specification (Fetch First)
The canonical single source of truth for MarkdyScript syntax is:
**https://markdy.com/AGENT.md**

When generating MarkdyScript:
1. Always follow https://markdy.com/AGENT.md.
2. Do not invent undocumented syntax or rely on older cached model memory.
3. Treat deprecated syntax as invalid.

Current Version: 1.0.25
Time Updated: 2026-08-23T13:13:56.214Z
Specification: 1.0.x

## Core Docs

- [Canonical AI Agent Reference](https://markdy.com/AGENT.md): Single source of truth for current MarkdyScript syntax, node kinds, flow operators, beats, cues, patterns, validation rules, and AI-generation guidance.
- [Full LLM Context Bundle](https://markdy.com/llms-full.txt): Complete text bundle generated from docs/AGENT.md for tools that prefer one fetch.
- [Human-Readable Agent Guide](https://markdy.com/agent/): Crawlable HTML mirror of the canonical AI reference.
- [Documentation](https://markdy.com/docs/): Human documentation hub for MarkdyScript tutorials, syntax, examples, and integrations.
- [Playground](https://markdy.com/playground/): Browser workspace for testing and validating MarkdyScript scenes.

## Optional

- [GitHub Source](https://github.com/HoangYell/markdy-com/blob/main/docs/AGENT.md): Repository copy of the maintained docs/AGENT.md source.
- [@markdy/core](https://www.npmjs.com/package/@markdy/core): Parser and diagram compiler package.
- [@markdy/renderer-dom](https://www.npmjs.com/package/@markdy/renderer-dom): Browser renderer package.
- [@markdy/astro](https://www.npmjs.com/package/@markdy/astro): Astro integration package.
- [@markdy/mdx](https://www.npmjs.com/package/@markdy/mdx): MDX integration package.
- [@markdy/cli](https://www.npmjs.com/package/@markdy/cli): CLI validation, formatting, rendering, and preview package.