-
-
Notifications
You must be signed in to change notification settings - Fork 3
Home
Yell edited this page Aug 25, 2026
·
2 revisions
Open-source diagram-as-code DSL for animated architecture & system design explainers.
- MarkdyScript Cheatsheet β Complete 1-page quick syntax reference.
- Mermaid Migration Guide β Side-by-side transpiler & visual comparison.
- AI Agent & MCP Setup β 1-minute configuration for Cursor, Claude, Antigravity, and Copilot.
- Awesome Markdy Showcase β Curated real-world architecture templates & patterns.
- FAQ & Troubleshooting β Answers to common developer questions and performance tips.
- β‘ Live Studio Playground β Experiment with 30+ interactive scenes in your browser.
- π Official Documentation β Full grammar specification, AST schema, and API guides.
- π 17+ Layout Examples Gallery β Live gallery of systems, roadmaps, and security perimeters.
- π€ AI LLMs Context (llms-full.txt) β Canonical context file for AI assistants.
Markdy is a diagram-as-code DSL built specifically for animated architecture diagrams and system-design explainers. Instead of drawing static boxes in visual design apps, you declare semantic nodes, groups, flows, and timed beats in plain text β Markdy compiles smooth 60fps Web Animations directly in the browser.
scene "Cache-Aside Architecture" theme=paper
layout LR
browser Client "Web Client"
gateway Gateway "API Gateway"
service Shortener "URL Service"
cache Redis "Redis Cluster"
database Postgres "PostgreSQL 16"
group app "Application Tier": Gateway Shortener
group data "Persistence Tier": Redis Postgres
beat hit "1. Sub-2ms Cache Hit Path":
show $nodes stagger=60ms
frame Client Gateway Shortener Redis zoom=1.1
Client -> Gateway "GET /x9" -> Shortener "resolve"
Shortener -> Redis "GET slug:x9"
Shortener <- Redis "200 Target URL"
Client <- Gateway "301 Redirect"
beat miss "2. Cache Miss Fallback & Async Warm":
frame Shortener Redis Postgres zoom=1.15
Shortener -> Postgres "SELECT destination WHERE slug = 'x9'"
Shortener <- Postgres "Row Found"
Shortener ~> Redis "SETEX slug:url (Warm Cache)"
glow Postgres color=#38bdf8 & glow Redis color=#22c55e
Markdy is an open-source project by Hoang Yell Β· Licensed under MIT