Files
heygen-com__hyperframes/docs/docs.json
Miguel Angel Simon Sierra bb912587b9 feat(primitives): add 25 video primitives, live docs pages, and the catalog retrieval eval
Adds the 25 video primitive compositions and their generated Mintlify pages.
Each page embeds a live <hyperframes-player> preview with editable composition
variables rather than a rendered MP4.

Adds the catalog-browsing eval under evals/catalog-retrieval: a 424-entry shelf
built from HEAD, nine retrieval conditions (no-catalog control, full read,
lexical, semantic, and hybrid across several values of k), a brief generator
that constructs each brief from a known target, a blind three-pass gold
validation committee, and a mechanical scorer that keeps mountable and fit as
two separate numbers.

The eval vendors its own shelf, primitive sources, and preview list instead of
reading them from an ignored working directory, so the shelf regenerates byte
for byte from a clean checkout. Derived artifacts stay out: the embedding cache
and the run checkpoints are regenerated rather than committed, so no run can
score against a stale copy of either.

Lint ignores now cover vendored minified player bundles by pattern instead of
one path at a time.
2026-07-31 12:27:41 +02:00

700 lines
24 KiB
JSON

{
"$schema": "https://mintlify.com/docs.json",
"name": "HyperFrames",
"theme": "maple",
"colors": {
"primary": "#0a0a0a",
"light": "#f6f5f1",
"dark": "#0a0a0a"
},
"background": {
"color": {
"light": "#f6f5f1",
"dark": "#0a0a0a"
}
},
"fonts": {
"family": "Inter",
"heading": {
"family": "Inter"
}
},
"appearance": {
"default": "light"
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"favicon": "/favicon.svg",
"contextual": {
"options": [
"copy",
"claude",
"cursor",
"vscode",
"windsurf",
"mcp",
{
"title": "Open an issue",
"description": "Report a bug or request a feature",
"icon": "github",
"iconType": "brands",
"href": "https://github.com/heygen-com/hyperframes/issues/new"
}
]
},
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Getting Started",
"pages": [
"spike-player",
"introduction",
"changelog",
"weekly-updates",
"quickstart",
"showcase",
"examples",
"launch-videos"
]
},
{
"group": "Concepts",
"pages": [
"concepts/compositions",
"concepts/data-attributes",
"concepts/variables",
"concepts/frame-adapters",
"concepts/determinism"
]
},
{
"group": "Guides",
"pages": [
"guides/pipeline",
"guides/skills",
"guides/authentication",
"guides/video-components",
"guides/color-grading",
"guides/html-in-canvas",
"guides/website-to-video",
"guides/figma",
"guides/antigravity",
"guides/copilot-cli",
"guides/claude-design",
"guides/open-design",
"guides/prompting",
"guides/hyperframes-vs-remotion",
"guides/gsap-animation",
"guides/keyframes",
"guides/rendering",
"guides/remove-background",
"guides/hdr",
"guides/4k-rendering",
"guides/performance",
"guides/timeline-editing",
"guides/video-editor-cheatsheet",
"guides/common-mistakes",
"guides/troubleshooting",
"guides/feedback"
]
},
{
"group": "Deploy",
"pages": [
"deploy/cloud",
"guides/deploy",
"deploy/aws-lambda",
"deploy/gcp-cloud-run",
"deploy/templates-on-lambda",
"deploy/migrating-to-hyperframes-lambda"
]
}
]
},
{
"tab": "Catalog",
"groups": [
{
"group": "Code Animations",
"pages": [
"catalog/blocks/code-3d-extrude",
"catalog/blocks/code-diff",
"catalog/blocks/code-highlight",
"catalog/blocks/code-morph",
"catalog/blocks/code-particle-assemble",
"catalog/blocks/code-scroll",
"catalog/blocks/code-shader-dissolve",
"catalog/blocks/code-snippet-flight",
"catalog/blocks/code-typing",
"catalog/components/code-accordion",
"catalog/components/glass-code-block",
"catalog/components/live-code-compilation",
"catalog/components/terminal-simulator"
]
},
{
"group": "Captions",
"pages": [
"catalog/components/caption-clip-wipe",
"catalog/components/caption-editorial-emphasis",
"catalog/components/caption-emoji-pop",
"catalog/components/caption-glitch-rgb",
"catalog/components/caption-gradient-fill",
"catalog/components/caption-highlight",
"catalog/components/caption-kinetic-slam",
"catalog/components/caption-matrix-decode",
"catalog/components/caption-neon-accent",
"catalog/components/caption-neon-glow",
"catalog/components/caption-parallax-layers",
"catalog/components/caption-particle-burst",
"catalog/components/caption-pill-karaoke",
"catalog/components/caption-texture",
"catalog/components/caption-weight-shift"
]
},
{
"group": "HTML-in-Canvas",
"pages": [
"catalog/blocks/ios26-liquid-glass",
"catalog/blocks/liquid-glass-context-menu",
"catalog/blocks/liquid-glass-media-controls",
"catalog/blocks/liquid-glass-notification",
"catalog/blocks/liquid-glass-widgets",
"catalog/blocks/macos-tahoe-liquid-glass",
"catalog/blocks/vfx-iphone-device",
"catalog/blocks/vfx-liquid-background",
"catalog/blocks/vfx-liquid-glass",
"catalog/blocks/vfx-magnetic",
"catalog/blocks/vfx-portal",
"catalog/blocks/vfx-shatter",
"catalog/blocks/vfx-text-cursor"
]
},
{
"group": "Social Overlays",
"pages": [
"catalog/blocks/instagram-follow",
"catalog/blocks/macos-notification",
"catalog/blocks/reddit-post",
"catalog/blocks/spotify-card",
"catalog/blocks/tiktok-follow",
"catalog/blocks/x-post",
"catalog/blocks/yt-lower-third",
"catalog/components/x-follow-card",
"catalog/components/x-followers-overview"
]
},
{
"group": "Lower Thirds",
"pages": [
"catalog/blocks/lower-third-bild",
"catalog/blocks/lt-accent-underline",
"catalog/blocks/lt-bold-block",
"catalog/blocks/lt-clean-bar",
"catalog/blocks/lt-color-block",
"catalog/blocks/lt-dark-card",
"catalog/blocks/lt-kicker-name",
"catalog/blocks/lt-mask-reveal",
"catalog/blocks/lt-side-rule",
"catalog/blocks/lt-soft-pill",
"catalog/blocks/lt-stack-bars",
"catalog/blocks/news-ticker"
]
},
{
"group": "Shader Transitions",
"pages": [
"catalog/blocks/chromatic-radial-split",
"catalog/blocks/cinematic-zoom",
"catalog/blocks/cross-warp-morph",
"catalog/blocks/domain-warp-dissolve",
"catalog/blocks/flash-through-white",
"catalog/blocks/glitch",
"catalog/blocks/gravitational-lens",
"catalog/blocks/light-leak",
"catalog/blocks/ridged-burn",
"catalog/blocks/ripple-waves",
"catalog/blocks/sdf-iris",
"catalog/blocks/swirl-vortex",
"catalog/blocks/thermal-distortion",
"catalog/blocks/whip-pan"
]
},
{
"group": "CSS Transitions",
"pages": [
"catalog/blocks/transitions-3d",
"catalog/blocks/transitions-blur",
"catalog/blocks/transitions-cover",
"catalog/blocks/transitions-destruction",
"catalog/blocks/transitions-dissolve",
"catalog/blocks/transitions-distortion",
"catalog/blocks/transitions-grid",
"catalog/blocks/transitions-light",
"catalog/blocks/transitions-mechanical",
"catalog/blocks/transitions-other",
"catalog/blocks/transitions-push",
"catalog/blocks/transitions-radial",
"catalog/blocks/transitions-scale"
]
},
{
"group": "Showcases",
"pages": [
"catalog/blocks/app-showcase",
"catalog/blocks/apple-money-count",
"catalog/blocks/blue-sweater-intro-video",
"catalog/blocks/north-korea-locked-down",
"catalog/blocks/nyc-paris-flight",
"catalog/blocks/ui-3d-reveal",
"catalog/blocks/vpn-youtube-spot",
"catalog/components/ai-generation-canvas",
"catalog/components/browser-flow",
"catalog/components/chat-to-preview-layout",
"catalog/components/data-flow-pipes",
"catalog/components/device-mockup-zoom",
"catalog/components/drag-and-drop-flow",
"catalog/components/ecosystem-constellation",
"catalog/components/hero-device-assemble",
"catalog/components/infinite-bento-pan",
"catalog/components/infinite-marquee",
"catalog/components/landing-code-showcase",
"catalog/components/pricing-tier-focus",
"catalog/components/terminal-to-browser-deploy"
]
},
{
"group": "Data",
"pages": [
"catalog/blocks/data-chart",
"catalog/blocks/spain-map",
"catalog/blocks/us-map",
"catalog/blocks/us-map-bubble",
"catalog/blocks/us-map-flow",
"catalog/blocks/us-map-hex",
"catalog/blocks/world-map",
"catalog/components/animated-bar-chart",
"catalog/components/animated-line-chart",
"catalog/components/dashboard-populate"
]
},
{
"group": "UI Primitives",
"pages": [
"catalog/components/accordion",
"catalog/components/alert",
"catalog/components/alert-dialog",
"catalog/components/aspect-ratio",
"catalog/components/avatar",
"catalog/components/backdrop",
"catalog/components/badge",
"catalog/components/blur-in",
"catalog/components/breadcrumb",
"catalog/components/button",
"catalog/components/button-group",
"catalog/components/calendar",
"catalog/components/card",
"catalog/components/caret",
"catalog/components/carousel",
"catalog/components/chart",
"catalog/components/checkbox",
"catalog/components/collapsible",
"catalog/components/combobox",
"catalog/components/command-menu",
"catalog/components/command-menu-item",
"catalog/components/context-menu",
"catalog/components/cursor",
"catalog/components/dialog",
"catalog/components/drawer",
"catalog/components/dropdown-menu",
"catalog/components/dropdown-menu-item",
"catalog/components/empty",
"catalog/components/field",
"catalog/components/hover-card",
"catalog/components/input",
"catalog/components/input-group",
"catalog/components/input-otp",
"catalog/components/item",
"catalog/components/kbd",
"catalog/components/label",
"catalog/components/menubar",
"catalog/components/native-select",
"catalog/components/navigation-menu",
"catalog/components/pagination",
"catalog/components/popover",
"catalog/components/progress",
"catalog/components/progress-steps",
"catalog/components/radio",
"catalog/components/registry",
"catalog/components/remocn-ui",
"catalog/components/resizable",
"catalog/components/scroll-area",
"catalog/components/select",
"catalog/components/select-item",
"catalog/components/separator",
"catalog/components/sheet",
"catalog/components/sidebar",
"catalog/components/skeleton",
"catalog/components/skeleton-block",
"catalog/components/slider",
"catalog/components/spinner",
"catalog/components/stepper",
"catalog/components/switch",
"catalog/components/table",
"catalog/components/tabs",
"catalog/components/textarea",
"catalog/components/toast",
"catalog/components/toggle",
"catalog/components/toggle-group",
"catalog/components/tooltip"
]
},
{
"group": "UI Flows",
"pages": [
"catalog/components/ai-prompt-flow",
"catalog/components/checkout-flow",
"catalog/components/onboarding-stepper-flow",
"catalog/components/settings-toggle-flow",
"catalog/components/signup-flow"
]
},
{
"group": "Transition Primitives",
"pages": [
"catalog/components/avatar-group-hover",
"catalog/components/badge-pop",
"catalog/components/card-resize",
"catalog/components/chromatic-aberration-wipe",
"catalog/components/code-diff-wipe",
"catalog/components/directional-wipe",
"catalog/components/frosted-glass-wipe",
"catalog/components/icon-swap",
"catalog/components/image-expand-to-fullscreen",
"catalog/components/input-feedback",
"catalog/components/menu-morph",
"catalog/components/micro-scale-fade",
"catalog/components/micro-transitions",
"catalog/components/number-pop-in",
"catalog/components/page-slide",
"catalog/components/panel-reveal",
"catalog/components/skeleton-reveal",
"catalog/components/spatial-push",
"catalog/components/success-check",
"catalog/components/tabs-slide-indicator",
"catalog/components/text-stagger",
"catalog/components/text-state-swap",
"catalog/components/tilt-card",
"catalog/components/tool-menu-slide-in",
"catalog/components/zoom-through-transition"
]
},
{
"group": "Motion Primitives",
"pages": [
"catalog/components/blur-out-up",
"catalog/components/bottom-up-letters",
"catalog/components/dynamic-grid",
"catalog/components/fade-through",
"catalog/components/focus-blur-resolve",
"catalog/components/inline-highlight",
"catalog/components/kinetic-center-build",
"catalog/components/line-by-line-slide",
"catalog/components/marker-highlight",
"catalog/components/mask-reveal-up",
"catalog/components/masked-slide-reveal",
"catalog/components/matrix-decode",
"catalog/components/number-wheel",
"catalog/components/per-character-rise",
"catalog/components/per-word-crossfade",
"catalog/components/perspective-marquee",
"catalog/components/rgb-glitch-text",
"catalog/components/rolling-number",
"catalog/components/scale-down-fade",
"catalog/components/shared-axis-y",
"catalog/components/shared-axis-z",
"catalog/components/short-slide-down",
"catalog/components/short-slide-right",
"catalog/components/simulated-cursor",
"catalog/components/slot-machine-roll",
"catalog/components/soft-blur-in",
"catalog/components/spring-scale-in",
"catalog/components/staggered-fade-up",
"catalog/components/strikethrough-replace",
"catalog/components/top-down-letters",
"catalog/components/tracking-in",
"catalog/components/typewriter"
]
},
{
"group": "Effects",
"pages": [
"catalog/components/confetti",
"catalog/components/grain-overlay",
"catalog/components/grid-pixelate-wipe",
"catalog/components/mesh-gradient-bg",
"catalog/components/parallax-unzoom",
"catalog/components/parallax-zoom",
"catalog/components/shimmer-sweep",
"catalog/components/spotlight-card",
"catalog/components/vignette"
]
},
{
"group": "Text Effects",
"pages": [
"catalog/components/caption-blend-difference",
"catalog/components/morph-text",
"catalog/components/texture-mask-text"
]
},
{
"group": "Blocks",
"pages": [
"catalog/blocks/flowchart",
"catalog/blocks/flowchart-vertical",
"catalog/blocks/logo-outro"
]
},
{
"group": "Code Snippets",
"pages": [
"catalog/blocks/code-snippet-apple-terminal-basic",
"catalog/blocks/code-snippet-apple-terminal-clear-dark",
"catalog/blocks/code-snippet-apple-terminal-clear-light",
"catalog/blocks/code-snippet-apple-terminal-grass",
"catalog/blocks/code-snippet-apple-terminal-homebrew",
"catalog/blocks/code-snippet-apple-terminal-man-page",
"catalog/blocks/code-snippet-apple-terminal-novel",
"catalog/blocks/code-snippet-apple-terminal-ocean",
"catalog/blocks/code-snippet-apple-terminal-pro",
"catalog/blocks/code-snippet-apple-terminal-red-sands",
"catalog/blocks/code-snippet-apple-terminal-silver-aerogel",
"catalog/blocks/code-snippet-apple-terminal-solid-colors",
"catalog/blocks/code-snippet-dark-2026",
"catalog/blocks/code-snippet-dark-modern",
"catalog/blocks/code-snippet-dark-plus",
"catalog/blocks/code-snippet-high-contrast",
"catalog/blocks/code-snippet-high-contrast-light",
"catalog/blocks/code-snippet-light-2026",
"catalog/blocks/code-snippet-light-modern",
"catalog/blocks/code-snippet-light-plus",
"catalog/blocks/code-snippet-monokai",
"catalog/blocks/code-snippet-solarized-light",
"catalog/blocks/code-snippet-visual-studio-dark",
"catalog/blocks/code-snippet-visual-studio-light"
]
},
{
"group": "MotionPath Primitives",
"pages": [
"catalog/components/arc-motion-path",
"catalog/components/bezier-callout-route",
"catalog/components/orbital-feature-path"
]
},
{
"group": "Advanced Motion",
"pages": [
"catalog/components/camera-rig-depth-stack",
"catalog/components/keyframe-scrub-stack",
"catalog/components/shader-displacement-panel",
"catalog/components/stagger-lattice",
"catalog/components/svg-line-draw-loader"
]
},
{
"group": "3D Primitives",
"pages": [
"catalog/components/three-orbiting-cards",
"catalog/components/three-particle-ribbon"
]
}
]
},
{
"tab": "Primitives",
"groups": [
{
"group": "Overview",
"pages": [
"primitives/index"
]
},
{
"group": "Annotation",
"pages": [
"primitives/caliper-caption-rail",
"primitives/marker-highlight",
"primitives/plan-room-audit",
"primitives/whiteboard-ink"
]
},
{
"group": "Camera moves",
"pages": [
"primitives/caption-camera-follow",
"primitives/depth-rack-focus",
"primitives/focus-rack",
"primitives/orbit-ring-camera"
]
},
{
"group": "Interface morphs",
"pages": [
"primitives/chevron-pill-card-morph"
]
},
{
"group": "Motion trails",
"pages": [
"primitives/echo-trail"
]
},
{
"group": "Text effects",
"pages": [
"primitives/glyph-ring-assemble",
"primitives/kinetic-type-swap",
"primitives/particle-text-dissolve",
"primitives/version-plate-type"
]
},
{
"group": "Transitions",
"pages": [
"primitives/grade-split-reveal",
"primitives/halftone-dissolve",
"primitives/match-cut",
"primitives/z-punch-through"
]
},
{
"group": "Card assembly",
"pages": [
"primitives/persona-card-fan",
"primitives/receipt-card"
]
},
{
"group": "Process sequences",
"pages": [
"primitives/pill-row-collapse",
"primitives/state-chip-rail"
]
},
{
"group": "Interaction",
"pages": [
"primitives/press-ripple"
]
},
{
"group": "List assembly",
"pages": [
"primitives/rank-list-settle",
"primitives/thread-message-stack"
]
}
]
},
{
"tab": "Packages",
"groups": [
{
"group": "Packages",
"pages": [
"packages/core",
"packages/parsers",
"packages/lint",
"packages/studio-server",
"packages/sdk",
"packages/engine",
"packages/player",
"packages/producer",
"packages/shader-transitions",
"packages/aws-lambda",
"packages/gcp-cloud-run",
"packages/studio",
"packages/cli"
]
}
]
},
{
"tab": "SDK",
"groups": [
{
"group": "Overview",
"pages": [
"sdk/overview",
"sdk/quickstart"
]
},
{
"group": "Guides",
"pages": [
"sdk/guides/querying-and-editing",
"sdk/guides/timing-and-animation",
"sdk/guides/undo-redo-and-patches",
"sdk/guides/persistence",
"sdk/guides/embedded-override-mode",
"sdk/guides/canvas-integration",
"sdk/guides/editing-affordances"
]
},
{
"group": "Reference",
"pages": [
"sdk/reference/open-composition",
"sdk/reference/composition",
"sdk/reference/edit-operations",
"sdk/reference/types",
"sdk/reference/adapters",
"sdk/reference/utilities"
]
}
]
},
{
"tab": "Reference",
"groups": [
{
"group": "Reference",
"pages": [
"reference/html-schema"
]
},
{
"group": "Contributing",
"pages": [
"contributing",
"contributing/catalog",
"contributing/release-channels",
"contributing/changelog-process",
"contributing/testing-local-changes",
"contributing/studio-manual-dom-editing"
]
},
{
"group": "Community",
"pages": [
"community/adopters"
]
}
]
}
]
},
"footer": {
"socials": {
"github": "https://github.com/heygen-com/hyperframes"
}
}
}