mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-14 18:01:20 +08:00
ukimsanov
645 lines
20 KiB
JSON
645 lines
20 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"name": "HyperFrames",
|
|
"theme": "aspen",
|
|
"colors": {
|
|
"primary": "#0a0a0a",
|
|
"light": "#f6f5f1",
|
|
"dark": "#0a0a0a"
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"light": "#f6f5f1",
|
|
"dark": "#0a0a0a"
|
|
}
|
|
},
|
|
"fonts": {
|
|
"family": "Inter",
|
|
"heading": {
|
|
"family": "Inter"
|
|
}
|
|
},
|
|
"appearance": {
|
|
"default": "system"
|
|
},
|
|
"logo": {
|
|
"light": "/logo/light.svg",
|
|
"dark": "/logo/dark.svg",
|
|
"href": "https://hyperframes.heygen.com/introduction"
|
|
},
|
|
"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": "Guides",
|
|
"icon": "book-open",
|
|
"groups": [
|
|
{
|
|
"group": "Start here",
|
|
"pages": [
|
|
"introduction",
|
|
"quickstart",
|
|
"go-further",
|
|
"developers/index"
|
|
]
|
|
},
|
|
{
|
|
"group": "Create with an agent",
|
|
"pages": [
|
|
"prompting/overview",
|
|
"guides/mcp",
|
|
"guides/pipeline",
|
|
"guides/design-tools"
|
|
]
|
|
},
|
|
{
|
|
"group": "Prompt by workflow",
|
|
"pages": [
|
|
"prompting/product-launch",
|
|
"prompting/explainers",
|
|
"prompting/code-and-prs",
|
|
"prompting/captions-and-talking-heads",
|
|
"prompting/music-and-slideshows",
|
|
"prompting/motion-graphics"
|
|
]
|
|
},
|
|
{
|
|
"group": "Control the result",
|
|
"pages": [
|
|
"prompting/anatomy",
|
|
"prompting/specification-dial",
|
|
"prompting/vocabulary",
|
|
"prompting/visual-specs",
|
|
"prompting/storyboards",
|
|
"prompting/iterating",
|
|
"prompting/recreating-references"
|
|
]
|
|
},
|
|
{
|
|
"group": "Motion and visuals",
|
|
"pages": [
|
|
"prompting/motion",
|
|
"prompting/transitions",
|
|
"prompting/code-blocks",
|
|
"prompting/data-and-maps",
|
|
"prompting/overlays-and-lower-thirds",
|
|
"prompting/captions-catalog",
|
|
"prompting/generated-artwork",
|
|
"prompting/vfx-and-liquid-glass",
|
|
"prompting/runtimes-and-3d"
|
|
]
|
|
},
|
|
{
|
|
"group": "Media and reusable systems",
|
|
"pages": [
|
|
"prompting/media-and-audio",
|
|
"prompting/design-systems",
|
|
"prompting/variables-and-templating",
|
|
"prompting/editing-existing-videos",
|
|
"prompting/rendering-and-output",
|
|
"prompting/remotion-migration"
|
|
]
|
|
},
|
|
{
|
|
"group": "Prompt examples and reference",
|
|
"pages": [
|
|
"prompting/examples",
|
|
"prompting/capstone",
|
|
"prompting/rules-and-anti-patterns"
|
|
]
|
|
},
|
|
{
|
|
"group": "Workflows",
|
|
"pages": [
|
|
"guides/product-launch-video",
|
|
"guides/faceless-explainer",
|
|
"guides/pr-to-video",
|
|
"guides/captions-and-recuts",
|
|
"guides/motion-graphics",
|
|
"guides/music-to-video",
|
|
"guides/slideshow",
|
|
"guides/general-video"
|
|
]
|
|
},
|
|
{
|
|
"group": "Learn",
|
|
"pages": [
|
|
"concepts/index",
|
|
"concepts/compositions",
|
|
"concepts/variables"
|
|
]
|
|
},
|
|
{
|
|
"group": "Media",
|
|
"pages": [
|
|
"guides/media",
|
|
"guides/video-components",
|
|
"guides/voice-and-audio",
|
|
"guides/transcribe-and-caption",
|
|
"guides/remove-background",
|
|
"guides/color-grading",
|
|
"guides/media-effects"
|
|
]
|
|
},
|
|
{
|
|
"group": "Export and share",
|
|
"pages": [
|
|
"guides/export-and-share",
|
|
"guides/quality-checklist",
|
|
"guides/publish-and-share",
|
|
"guides/rendering"
|
|
]
|
|
},
|
|
{
|
|
"group": "Examples",
|
|
"pages": [
|
|
"examples"
|
|
]
|
|
},
|
|
{
|
|
"group": "Help",
|
|
"pages": [
|
|
"help",
|
|
"guides/troubleshooting",
|
|
"guides/feedback"
|
|
]
|
|
},
|
|
{
|
|
"group": "What's new",
|
|
"pages": [
|
|
"product-updates"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Studio",
|
|
"icon": "palette",
|
|
"groups": [
|
|
{
|
|
"group": "Overview",
|
|
"pages": [
|
|
"studio/index",
|
|
"studio/tour"
|
|
]
|
|
},
|
|
{
|
|
"group": "Review",
|
|
"pages": [
|
|
"studio/storyboard"
|
|
]
|
|
},
|
|
{
|
|
"group": "Edit",
|
|
"pages": [
|
|
"studio/canvas",
|
|
"studio/layers",
|
|
"studio/timeline",
|
|
"studio/design",
|
|
"studio/animation",
|
|
"guides/keyframes"
|
|
]
|
|
},
|
|
{
|
|
"group": "Build",
|
|
"pages": [
|
|
"studio/assets-and-blocks",
|
|
"studio/captions",
|
|
"studio/variables",
|
|
"studio/slideshows",
|
|
"studio/source"
|
|
]
|
|
},
|
|
{
|
|
"group": "Finish",
|
|
"pages": [
|
|
"studio/lint-and-agent",
|
|
"studio/export",
|
|
"studio/shortcuts",
|
|
"studio/troubleshooting"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Catalog",
|
|
"icon": "grid-2",
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"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/editorial-flash-overlay",
|
|
"catalog/blocks/freeze-frame-dressing",
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"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/organic-light-leak-overlay",
|
|
"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/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",
|
|
"catalog/blocks/north-korea-locked-down",
|
|
"catalog/blocks/nyc-paris-flight",
|
|
"catalog/blocks/ui-3d-reveal",
|
|
"catalog/blocks/vpn-youtube-spot"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"group": "Effects",
|
|
"pages": [
|
|
"catalog/components/caption-blend-difference",
|
|
"catalog/components/grain-overlay",
|
|
"catalog/components/grid-pixelate-wipe",
|
|
"catalog/components/morph-text",
|
|
"catalog/components/motion-blur",
|
|
"catalog/components/parallax-unzoom",
|
|
"catalog/components/parallax-zoom",
|
|
"catalog/components/shimmer-sweep",
|
|
"catalog/components/texture-mask-text",
|
|
"catalog/components/vignette"
|
|
]
|
|
},
|
|
{
|
|
"group": "Blocks",
|
|
"pages": [
|
|
"catalog/blocks/camcorder-hud",
|
|
"catalog/blocks/flowchart",
|
|
"catalog/blocks/flowchart-vertical",
|
|
"catalog/blocks/logo-outro"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Developers",
|
|
"icon": "code",
|
|
"groups": [
|
|
{
|
|
"group": "Overview",
|
|
"pages": [
|
|
"developers/overview"
|
|
]
|
|
},
|
|
{
|
|
"group": "Command line",
|
|
"pages": [
|
|
"developers/cli",
|
|
"packages/cli",
|
|
"packages/lint"
|
|
]
|
|
},
|
|
{
|
|
"group": "SDK",
|
|
"pages": [
|
|
"sdk/overview",
|
|
"sdk/quickstart",
|
|
"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",
|
|
"sdk/reference/open-composition",
|
|
"sdk/reference/composition",
|
|
"sdk/reference/edit-operations",
|
|
"sdk/reference/types",
|
|
"sdk/reference/adapters",
|
|
"sdk/reference/utilities"
|
|
]
|
|
},
|
|
{
|
|
"group": "Composition and animation",
|
|
"pages": [
|
|
"reference/html-schema",
|
|
"concepts/data-attributes",
|
|
"guides/gsap-animation",
|
|
"concepts/frame-adapters",
|
|
"concepts/determinism",
|
|
"guides/html-in-canvas",
|
|
"guides/hyperframes-vs-remotion"
|
|
]
|
|
},
|
|
{
|
|
"group": "Rendering and deployment",
|
|
"pages": [
|
|
"deploy/overview",
|
|
"deploy/cloud",
|
|
"guides/deploy",
|
|
"deploy/aws-lambda",
|
|
"deploy/gcp-cloud-run",
|
|
"deploy/templates-on-lambda",
|
|
"deploy/migrating-to-hyperframes-lambda",
|
|
"packages/aws-lambda",
|
|
"packages/gcp-cloud-run"
|
|
]
|
|
},
|
|
{
|
|
"group": "Advanced rendering",
|
|
"pages": [
|
|
"guides/4k-rendering",
|
|
"guides/hdr",
|
|
"guides/performance"
|
|
]
|
|
},
|
|
{
|
|
"group": "Packages",
|
|
"pages": [
|
|
"packages/core",
|
|
"packages/parsers",
|
|
"packages/studio-server",
|
|
"packages/sdk",
|
|
"packages/engine",
|
|
"packages/player",
|
|
"packages/producer",
|
|
"packages/shader-transitions",
|
|
"packages/studio"
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
"guides/authentication",
|
|
"guides/skills",
|
|
"guides/figma",
|
|
"guides/antigravity",
|
|
"guides/copilot-cli"
|
|
]
|
|
},
|
|
{
|
|
"group": "Contributing",
|
|
"pages": [
|
|
"contributing",
|
|
"contributing/catalog",
|
|
"contributing/release-channels",
|
|
"contributing/changelog-process",
|
|
"contributing/testing-local-changes",
|
|
"community/adopters"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"github": "https://github.com/heygen-com/hyperframes"
|
|
}
|
|
},
|
|
"navbar": {
|
|
"links": [
|
|
{
|
|
"type": "github",
|
|
"href": "https://github.com/heygen-com/hyperframes"
|
|
}
|
|
],
|
|
"primary": {
|
|
"type": "button",
|
|
"label": "Playground",
|
|
"href": "https://www.hyperframes.dev/"
|
|
}
|
|
},
|
|
"redirects": [
|
|
{
|
|
"source": "/guides",
|
|
"destination": "/introduction"
|
|
},
|
|
{
|
|
"source": "/showcase",
|
|
"destination": "/examples"
|
|
},
|
|
{
|
|
"source": "/launch-videos",
|
|
"destination": "/examples"
|
|
},
|
|
{
|
|
"source": "/guides/claude-design",
|
|
"destination": "/guides/design-tools"
|
|
},
|
|
{
|
|
"source": "/guides/open-design",
|
|
"destination": "/guides/design-tools"
|
|
},
|
|
{
|
|
"source": "/guides/common-mistakes",
|
|
"destination": "/guides/troubleshooting"
|
|
},
|
|
{
|
|
"source": "/guides/create-with-agent",
|
|
"destination": "/workflows"
|
|
},
|
|
{
|
|
"source": "/guides/choose-your-path",
|
|
"destination": "/workflows"
|
|
},
|
|
{
|
|
"source": "/guides/help",
|
|
"destination": "/help"
|
|
},
|
|
{
|
|
"source": "/guides/project-tour",
|
|
"destination": "/concepts"
|
|
},
|
|
{
|
|
"source": "/guides/media-overlays",
|
|
"destination": "/catalog"
|
|
},
|
|
{
|
|
"source": "/guides/common-questions",
|
|
"destination": "/help"
|
|
},
|
|
{
|
|
"source": "/weekly-updates",
|
|
"destination": "/product-updates"
|
|
},
|
|
{
|
|
"source": "/contributing/studio-manual-dom-editing",
|
|
"destination": "/studio/canvas"
|
|
},
|
|
{
|
|
"source": "/guides/video-editor-cheatsheet",
|
|
"destination": "/studio/shortcuts"
|
|
},
|
|
{
|
|
"source": "/guides/timeline-editing",
|
|
"destination": "/studio/timeline"
|
|
},
|
|
{
|
|
"source": "/guides/website-to-video",
|
|
"destination": "/guides/product-launch-video"
|
|
},
|
|
{
|
|
"source": "/guides/prompting",
|
|
"destination": "/prompting/overview",
|
|
"permanent": true
|
|
}
|
|
]
|
|
}
|