π₯ Make videos programmatically with React
// @ts-expect-error
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
const sidebars: SidebarsConfig = {
apiSidebar: [
'api',
{
type: 'category',
label: 'Command line',
link: {
type: 'doc',
id: 'cli/cli',
},
collapsed: true,
items: [
'cli/create-video',
'cli/studio',
'cli/render',
'cli/still',
'cli/compositions',
'cli/bundle',
{
type: 'category',
label: 'lambda',
link: {
type: 'doc',
id: 'lambda/cli',
},
items: [
{
type: 'category',
label: 'sites',
link: {
type: 'doc',
id: 'lambda/cli/sites',
},
items: [
'lambda/cli/sites/create',
'lambda/cli/sites/ls',
'lambda/cli/sites/rm',
'lambda/cli/sites/rmall',
],
},
{
type: 'category',
label: 'functions',
link: {
type: 'doc',
id: 'lambda/cli/functions',
},
items: [
'lambda/cli/functions/deploy',
'lambda/cli/functions/ls',
'lambda/cli/functions/rm',
'lambda/cli/functions/rmall',
],
},
'lambda/cli/render',
'lambda/cli/still',
'lambda/cli/policies',
'lambda/cli/compositions',
'lambda/cli/regions',
'lambda/cli/quotas',
],
},
{
type: 'category',
label: 'cloudrun',
link: {
type: 'doc',
id: 'cloudrun/cli',
},
items: [
{
type: 'category',
label: 'sites',
link: {
type: 'doc',
id: 'cloudrun/cli/sites',
},
items: [
'cloudrun/cli/sites/create',
'cloudrun/cli/sites/ls',
'cloudrun/cli/sites/rm',
'cloudrun/cli/sites/rmall',
],
},
{
type: 'category',
label: 'services',
link: {
type: 'doc',
id: 'cloudrun/cli/services',
},
items: [
'cloudrun/cli/services/deploy',
'cloudrun/cli/services/ls',
'cloudrun/cli/services/rm',
'cloudrun/cli/services/rmall',
],
},
'cloudrun/cli/render',
'cloudrun/cli/still',
'cloudrun/cli/permissions',
'cloudrun/cli/regions',
],
},
'cli/benchmark',
{
type: 'category',
label: 'browser',
link: {
type: 'doc',
id: 'cli/browser/index',
},
items: ['cli/browser/ensure'],
},
'cli/versions',
'cli/upgrade',
'cli/add',
'cli/skills',
'cli/ffmpeg',
'cli/ffprobe',
'cli/gpu',
'cli/help',
],
},
'config',
{
type: 'category',
label: 'Options',
link: {type: 'doc', id: 'options/index'},
collapsed: true,
items: [{type: 'autogenerated', dirName: 'options'}],
},
{
type: 'html',
value:
'<hr style="margin-top: 4px; margin-bottom: 4px; border-bottom: none"/>', // The HTML to be rendered
defaultStyle: true, // Use the default menu item styling
},
{
type: 'category',
label: 'remotion',
link: {
type: 'doc',
id: 'remotion',
},
items: [
'absolute-fill',
'artifact',
'calculate-metadata',
'cancel-render',
'canvasimage',
'composition',
'create-effect',
'continue-render',
'delay-render',
'easing',
'folder',
'freeze',
'get-input-props',
'get-remotion-environment',
'getstaticfiles',
'html5-audio',
'html5-video',
'remotion/html-in-canvas',
'iframe',
'img',
'interactive',
'interpolate-colors',
'interpolate',
'loop',
'measure-spring',
'offthreadvideo',
'animatedimage',
'prefetch',
'random',
'register-root',
'sequence',
'interactivity-schema',
'series',
'spring',
'solid',
'staticfile',
'still',
'track',
'use-buffer-state',
'use-current-frame',
'use-current-scale',
'use-pixel-density',
'use-delay-render',
'use-remotion-environment',
'use-video-config',
'version',
'watchstaticfile',
'interactive-create',
'interactive-with-schema',
],
},
{
type: 'category',
label: '@remotion/animated-emoji',
link: {
type: 'doc',
id: 'animated-emoji/index',
},
items: [
'animated-emoji/animated-emoji',
'animated-emoji/get-available-emoji',
],
},
{
type: 'category',
label: '@remotion/animation-utils',
link: {
type: 'doc',
id: 'animation-utils/index',
},
items: [
'animation-utils/make-transform',
'animation-utils/interpolate-styles',
],
},
{
type: 'category',
label: '@remotion/bundler',
link: {
type: 'doc',
id: 'bundler',
},
items: ['bundle'],
},
{
type: 'category',
label: '@remotion/captions',
link: {
type: 'doc',
id: 'captions/api',
},
items: [
'captions/caption',
'captions/parse-srt',
'captions/parse-vtt',
'captions/serialize-srt',
'captions/create-tiktok-style-captions',
],
},
{
type: 'category',
label: '@remotion/cloudrun',
link: {
type: 'doc',
id: 'cloudrun/api',
},
items: [
{
type: 'link',
href: '/docs/cloudrun/cli',
label: 'CLI Reference',
},
'cloudrun/getserviceinfo',
'cloudrun/deployservice',
'cloudrun/deleteservice',
'cloudrun/getservices',
'cloudrun/speculateservicename',
'cloudrun/getregions',
'cloudrun/deploysite',
'cloudrun/deletesite',
'cloudrun/getsites',
'cloudrun/getorcreatebucket',
'cloudrun/rendermediaoncloudrun',
'cloudrun/renderstilloncloudrun',
'cloudrun/testpermissions',
],
},
{
type: 'category',
label: '@remotion/effects',
link: {
type: 'doc',
id: 'effects/effects-api',
},
items: [
'effects/barrel-distortion',
'effects/bevel-alpha',
'effects/blur',
'effects/brightness',
'effects/burlap',
'effects/checkerboard',
'effects/chromatic-aberration',
'effects/color-correction',
'effects/color-key',
'effects/contrast',
'effects/contour-lines',
'effects/corner-pin',
'effects/cylinder',
'effects/dot-grid',
'effects/drop-shadow',
'effects/duotone',
'effects/emboss',
'effects/evolve',
'effects/exposure',
'effects/fisheye',
'effects/flannel',
'effects/fractal-noise',
'effects/glow',
'effects/grayscale',
'effects/gridlines',
'effects/halftone',
'effects/halftone-linear-gradient',
'effects/hue',
'effects/invert',
'effects/lens-blur',
'effects/levels',
'effects/linear-gradient',
'effects/linear-gradient-tint',
'effects/linear-progressive-blur',
'effects/linear-progressive-pixelate',
'effects/light-leak',
'effects/light-trail',
'effects/lines',
'effects/liquid-contours',
'effects/long-shadows',
'effects/lut',
'effects/mirror',
'effects/noise',
'effects/noise-displacement',
'effects/outline',
'effects/page-turn',
'effects/paper',
'effects/pattern',
'effects/pixel-dissolve',
'effects/pixelate',
'effects/radial-progressive-blur',
'effects/radial-progressive-pixelate',
'effects/region-blur',
'effects/rings',
'effects/roughen-edges',
'effects/saturation',
'effects/scale',
'effects/scanlines',
'effects/shadows-highlights',
'effects/shine',
'effects/shrinkwrap',
'effects/skew',
'effects/speckle',
'effects/sphere',
'effects/starburst',
'effects/tear',
'effects/thermal-vision',
'effects/tile',
'effects/tint',
'effects/turbulent-displace',
'effects/tv-signal-off',
'effects/uv-translate',
'effects/venetian-blinds',
'effects/vibrance',
'effects/vignette',
'effects/wave',
'effects/waves',
'effects/white-balance',
'effects/white-noise',
'effects/xy-translate',
'effects/zigzag',
'effects/zoom-blur',
],
},
{
type: 'category',
label: '@remotion/elevenlabs',
link: {
type: 'doc',
id: 'elevenlabs/index',
},
items: [
'elevenlabs/elevenlabs-transcript-to-captions',
'elevenlabs/detect-elevenlabs-transcript-format',
],
},
{
type: 'category',
label: '@remotion/enable-scss',
link: {
type: 'doc',
id: 'enable-scss/overview',
},
items: ['enable-scss/enable-scss'],
},
'eslint-config',
'eslint-plugin',
{
type: 'category',
label: '@remotion/fonts',
link: {
type: 'doc',
id: 'fonts-api/fonts-api',
},
items: ['fonts-api/load-font'],
},
{
type: 'category',
label: '@remotion/gif',
link: {
type: 'doc',
id: 'gif/index',
},
items: ['gif/gif', 'gif/get-gif-duration-in-seconds', 'gif/preload-gif'],
},
{
type: 'category',
label: '@remotion/google-fonts',
link: {
type: 'doc',
id: 'google-fonts/google-fonts',
},
items: [
'google-fonts/load-font',
'google-fonts/load-variable-font',
'google-fonts/get-available-fonts',
'google-fonts/get-info',
'google-fonts/load-font-from-info',
'google-fonts/load-variable-font-from-info',
],
},
{
type: 'category',
label: '@remotion/gsap',
link: {
type: 'doc',
id: 'gsap/gsap-index',
},
items: ['gsap/use-gsap-timeline'],
},
{
type: 'category',
label: '@remotion/install-whisper-cpp',
link: {
type: 'doc',
id: 'install-whisper-cpp/index',
},
items: [
'install-whisper-cpp/install-whisper-cpp',
'install-whisper-cpp/download-whisper-model',
'install-whisper-cpp/transcribe',
'install-whisper-cpp/to-captions',
'install-whisper-cpp/convert-to-captions',
],
},
{
type: 'category',
label: '@remotion/lambda',
link: {
type: 'doc',
id: 'lambda/api',
},
items: [
{
type: 'link',
href: '/docs/lambda/cli',
label: 'CLI Reference',
},
'lambda/estimateprice',
'lambda/deployfunction',
'lambda/deletefunction',
'lambda/getfunctioninfo',
'lambda/getfunctions',
'lambda/deletesite',
'lambda/deploysite',
'lambda/deploysitefrombundle',
'lambda/getawsclient',
'lambda/getregions',
'lambda/getsites',
'lambda/downloadmedia',
'lambda/deleterender',
'lambda/getuserpolicy',
'lambda/getrolepolicy',
'lambda/getcompositionsonlambda',
'lambda/getorcreatebucket',
'lambda/getrenderprogress',
'lambda/presignurl',
'lambda/renderframesonlambda',
'lambda/rendermediaonlambda',
'lambda/cancelrenderonlambda',
'lambda/renderstillonlambda',
'lambda/simulatepermissions',
'lambda/speculatefunctionname',
'lambda/validatewebhooksignature',
'lambda/approuterwebhook',
'lambda/pagesrouterwebhook',
'lambda/expresswebhook',
],
},
{
type: 'category',
label: '@remotion/layout-utils',
link: {
type: 'doc',
id: 'layout-utils/index',
},
items: [
'layout-utils/best-practices',
'layout-utils/measure-text',
'layout-utils/fill-text-box',
'layout-utils/fit-text',
'layout-utils/fit-text-on-n-lines',
'layout-utils/debug',
],
},
{
type: 'category',
label: '@remotion/licensing',
link: {
type: 'doc',
id: 'licensing/index',
},
items: ['licensing/register-usage-event', 'licensing/get-usage'],
},
{
type: 'category',
label: '@remotion/lottie',
link: {
type: 'doc',
id: 'lottie/lottie-index',
},
items: [
'lottie/lottie-comp',
'lottie/getlottiemetadata',
'lottie/lottie-staticfile',
'lottie/lottie-remote',
'lottie/lottie-lottiefiles',
],
},
{
type: 'category',
label: '@remotion/mac-cursors',
link: {
type: 'doc',
id: 'mac-cursors/mac-cursors-api',
},
items: ['mac-cursors/mac-os-cursor'],
},
{
type: 'category',
label: '@remotion/media',
link: {
type: 'doc',
id: 'media/index',
},
items: [
'media/audio',
'media/video',
'media/support',
'media/fallback',
'media/cache',
],
},
{
type: 'category',
label: '@remotion/media-utils',
link: {
type: 'doc',
id: 'media-utils/index',
},
items: [
'audio-buffer-to-data-url',
'get-audio-data',
'get-audio-duration-in-seconds',
'get-video-metadata',
'get-waveform-portion',
'use-audio-data',
'use-windowed-audio-data',
'visualize-audio',
'media-utils/visualize-audio-waveform',
'media-utils/create-smooth-svg-path',
'get-image-dimensions',
],
},
{
type: 'category',
label: '@remotion/motion-blur',
link: {
type: 'doc',
id: 'motion-blur/api',
},
items: [
'motion-blur/html-in-canvas-motion-blur',
'motion-blur/camera-motion-blur',
'motion-blur/trail',
'motion-blur/common-mistake',
],
},
{
type: 'category',
label: '@remotion/noise',
link: {
type: 'doc',
id: 'noise/index',
},
items: ['noise/noise-2d', 'noise/noise-3d', 'noise/noise-4d'],
},
{
type: 'category',
label: '@remotion/openai-whisper',
link: {
type: 'doc',
id: 'openai-whisper/index',
},
items: [
'openai-whisper/openai-whisper-api-to-captions',
'openai-whisper/is-openai-whisper-transcript',
],
},
{
type: 'category',
label: '@remotion/paths',
link: {
type: 'doc',
id: 'paths/index',
},
items: [
'paths/get-length',
'paths/get-point-at-length',
'paths/get-tangent-at-length',
'paths/get-instruction-index-at-length',
'paths/reverse-path',
'paths/normalize-path',
'paths/interpolate-path',
'paths/interpolate-paths',
'paths/evolve-path',
'paths/reset-path',
'paths/center-path',
'paths/get-subpaths',
'paths/translate-path',
'paths/warp-path',
'paths/scale-path',
'paths/get-bounding-box',
'paths/extend-viewbox',
'paths/parse-path',
'paths/serialize-instructions',
'paths/reduce-instructions',
'paths/get-parts',
],
},
{
type: 'category',
label: '@remotion/player',
link: {
type: 'doc',
id: 'player/installation',
},
items: [
{
type: 'link',
href: '/docs/player',
label: 'Guide + Examples',
},
'player/api',
'player/thumbnail',
],
},
{
type: 'category',
label: '@remotion/preload',
link: {
type: 'doc',
id: 'preload/preload',
},
items: [
'preload/preload-video',
'preload/preload-audio',
'preload/preload-image',
'preload/preload-font',
'preload/resolve-redirect',
],
},
{
type: 'category',
label: '@remotion/renderer',
link: {
type: 'doc',
id: 'renderer',
},
items: [
'renderer/get-compositions',
'renderer/select-composition',
'renderer/render-media',
'renderer/render-frames',
'renderer/render-still',
'renderer/stitch-frames-to-video',
'renderer/open-browser',
'renderer/ensure-browser',
'renderer/make-cancel-signal',
'renderer/ensure-ffmpeg',
'renderer/ensure-ffprobe',
'renderer/get-video-metadata',
'renderer/get-silent-parts',
'renderer/combine-chunks',
'renderer/extract-audio',
'renderer/types',
],
},
{
type: 'category',
label: '@remotion/rive',
link: {
type: 'doc',
id: 'rive/index',
},
items: ['rive/index', 'rive/remotionrivecanvas'],
},
{
type: 'category',
label: '@remotion/rough-notation',
link: {
type: 'doc',
id: 'rough-notation/rough-notation-api',
},
items: [
'rough-notation/box',
'rough-notation/bracket',
'rough-notation/circle',
'rough-notation/crossed-off',
'rough-notation/highlight',
'rough-notation/strike-through',
'rough-notation/underline',
],
},
{
type: 'category',
label: '@remotion/rounded-text-box',
link: {
type: 'doc',
id: 'rounded-text-box/index',
},
items: ['rounded-text-box/create-rounded-text-box'],
},
{
type: 'category',
label: '@remotion/sfx',
link: {
type: 'doc',
id: 'sfx/index',
},
items: [
'sfx/whip',
'sfx/whoosh',
'sfx/page-turn',
'sfx/ui-switch',
'sfx/mouse-click',
'sfx/shutter-modern',
'sfx/shutter-old',
'sfx/ding',
'sfx/bruh',
'sfx/vine-boom',
'sfx/windows-xp-error',
'sfx/fah',
'sfx/spongebob-fail',
'sfx/omg-hell-nah',
'sfx/price-is-right-fail',
'sfx/romance-meme',
'sfx/bone-crack',
'sfx/anime-wow',
'sfx/yippee',
'sfx/loading-lag',
'sfx/wilhelm-scream',
'sfx/mac-quack',
'sfx/skedaddle',
'sfx/snapchat-notification',
'sfx/nelly-ahh',
'sfx/sanctuary-guardian-what',
'sfx/minecraft-hurt',
'sfx/oh-my-god-vine',
'sfx/illuminati-confirmed',
'sfx/dramatic-boomer',
'sfx/triggered',
'sfx/record-scratch',
],
},
{
type: 'category',
label: '@remotion/shapes',
link: {
type: 'doc',
id: 'shapes/index',
},
items: [
'shapes/arrow',
'shapes/rect',
'shapes/callout',
'shapes/triangle',
'shapes/circle',
'shapes/ellipse',
'shapes/heart',
'shapes/spark',
'shapes/star',
'shapes/pie',
'shapes/polygon',
'shapes/make-arrow',
'shapes/make-rect',
'shapes/make-callout',
'shapes/make-triangle',
'shapes/make-circle',
'shapes/make-ellipse',
'shapes/make-heart',
'shapes/make-spark',
'shapes/make-star',
'shapes/make-pie',
'shapes/make-polygon',
],
},
{
type: 'category',
label: '@remotion/skia',
link: {
type: 'doc',
id: 'skia/skia',
},
items: ['skia/enable-skia', 'skia/skia-canvas'],
},
{
type: 'category',
label: '@remotion/studio',
link: {
type: 'doc',
id: 'studio/api',
},
items: [
'studio/get-static-files',
'studio/watch-public-folder',
'studio/watch-static-file',
'studio/write-static-file',
'studio/delete-static-file',
'studio/restart-studio',
'studio/shut-down-studio',
'studio/save-default-props',
'studio/play',
'studio/pause',
'studio/toggle',
'studio/seek',
'studio/go-to-composition',
'studio/update-default-props',
'studio/focus-default-props-path',
'studio/reevaluate-composition',
'studio/visual-control',
],
},
{
type: 'category',
label: '@remotion/studio-protocol',
link: {
type: 'doc',
id: 'studio-protocol/index',
},
items: [
'studio-protocol/create-element-payload',
'studio-protocol/static-file-ref',
'studio-protocol/build-open-in-remotion-new-url',
'studio-protocol/set-studio-drag-data',
'studio-protocol/install-in-studio',
'studio-protocol/add-element-library-to-studio',
'studio-protocol/subscribe-to-caption-style-selection',
'studio-protocol/is-inside-studio',
'studio-protocol/security',
],
},
{
type: 'category',
label: '@remotion/tailwind',
link: {
type: 'doc',
id: 'tailwind/tailwind',
},
items: ['tailwind/enable-tailwind'],
},
{
type: 'category',
label: '@remotion/tailwind-v4',
link: {
type: 'doc',
id: 'tailwind-v4/overview',
},
items: ['tailwind-v4/enable-tailwind'],
},
{
type: 'category',
label: '@remotion/three',
link: {
type: 'doc',
id: 'three',
},
items: [
'three-canvas',
'three-webgpu-canvas',
'use-video-texture',
'use-offthread-video-texture',
],
},
{
type: 'category',
label: '@remotion/transitions',
link: {
type: 'doc',
id: 'transitions/index',
},
items: [
'transitions/transitionseries',
'transitions/use-transition-progress',
'transitions/make-html-in-canvas-presentation',
{
type: 'category',
label: 'Timings',
link: {
type: 'doc',
id: 'transitions/timings/index',
},
items: [
'transitions/timings/springtiming',
'transitions/timings/lineartiming',
'transitions/timings/custom',
],
},
{
type: 'category',
label: 'Presentations',
link: {
type: 'doc',
id: 'transitions/presentations/index',
},
items: [
'transitions/presentations/fade',
'transitions/presentations/push-cut',
'transitions/presentations/slide',
'transitions/presentations/wipe',
'transitions/presentations/flip',
'transitions/presentations/clock-wipe',
'transitions/presentations/iris',
'transitions/presentations/book-flip',
'transitions/presentations/zoom-blur',
'transitions/presentations/dreamy-zoom',
'transitions/presentations/film-burn',
'transitions/presentations/linear-blur',
'transitions/presentations/zoom-in-out',
'transitions/presentations/dissolve',
'transitions/presentations/ripple',
'transitions/presentations/crosswarp',
'transitions/presentations/cross-zoom',
'transitions/presentations/swap',
'transitions/presentations/blur-slide',
'transitions/presentations/none',
{
type: 'doc',
id: 'transitions/presentations/cube',
className: 'pro-item',
},
'transitions/presentations/custom',
'transitions/presentations/custom-html-in-canvas',
'transitions/audio-transitions',
],
},
],
},
{
type: 'category',
label: '@remotion/vercel',
link: {
type: 'doc',
id: 'vercel/vercel-api',
},
items: [
'vercel/create-sandbox',
'vercel/add-bundle-to-sandbox',
'vercel/render-media-on-vercel',
'vercel/get-render-progress',
'vercel/render-still-on-vercel',
'vercel/upload-to-vercel-blob',
'vercel/vercel-types',
],
},
{
type: 'category',
label: '@remotion/video-matting',
link: {
type: 'doc',
id: 'video-matting/index',
},
items: [
{
type: 'doc',
id: 'video-matting/node',
label: 'Usage in Node.js',
},
'video-matting/can-use-video-matting',
'video-matting/get-available-models',
'video-matting/is-video-matting-model-cached',
'video-matting/download-video-matting-model',
'video-matting/load-video-matting-model',
'video-matting/remove-video-matting-model',
'video-matting/separate-video-layers',
'video-matting/dispose-video-matting-model',
],
},
{
type: 'category',
label: '@remotion/web-renderer',
link: {
type: 'doc',
id: 'web-renderer/index',
},
items: [
{
type: 'link',
href: '/docs/client-side-rendering',
label: 'Guide',
},
'web-renderer/render-media-on-web',
'web-renderer/render-still-on-web',
'web-renderer/can-render-media-on-web',
'web-renderer/get-encodable-video-codecs',
'web-renderer/get-encodable-audio-codecs',
'web-renderer/types',
],
},
{
type: 'category',
label: '@remotion/whisper-web',
link: {
type: 'doc',
id: 'whisper-web/index',
},
items: [
'whisper-web/download-whisper-model',
'whisper-web/transcribe',
'whisper-web/resample-to-16khz',
'whisper-web/can-use-whisper-web',
'whisper-web/get-available-models',
'whisper-web/get-loaded-models',
'whisper-web/to-captions',
],
},
{
type: 'category',
label: '@remotion/whisper-webgpu',
link: {
type: 'doc',
id: 'whisper-webgpu/index',
},
items: [
{
type: 'doc',
id: 'whisper-webgpu/node',
label: 'Usage in Node.js',
},
'whisper-webgpu/can-use-whisper-webgpu',
'whisper-webgpu/get-available-models',
'whisper-webgpu/clear-stale-models',
'whisper-webgpu/is-whisper-model-cached',
'whisper-webgpu/download-whisper-model',
'whisper-webgpu/load-whisper-model',
'whisper-webgpu/remove-whisper-model',
'whisper-webgpu/transcribe',
'whisper-webgpu/to-captions',
'whisper-webgpu/resample-to-16khz',
'whisper-webgpu/dispose-whisper-model',
],
},
{
type: 'category',
label: '@remotion/zod-types',
link: {
type: 'doc',
id: 'zod-types/index',
},
items: [
'zod-types/z-color',
'zod-types/z-textarea',
'zod-types/z-matrix',
'zod-types/v3',
],
},
{
type: 'html',
value:
'<hr style="margin-top: 4px; margin-bottom: 4px; border-bottom: none"/>',
defaultStyle: true,
},
{
type: 'category',
label: '@remotion/light-leaks (deprecated)',
link: {
type: 'doc',
id: 'light-leaks/light-leaks-api',
},
items: ['light-leaks/light-leak-effect', 'light-leaks/light-leak'],
},
{
type: 'category',
label: '@remotion/media-parser (deprecated)',
link: {
type: 'doc',
id: 'media-parser/index',
},
items: [
{
type: 'link',
href: '/docs/media-parser',
label: 'Guide',
},
'media-parser/types',
'media-parser/parse-media',
'media-parser/download-and-parse-media',
'media-parser/media-parser-controller',
'media-parser/parse-media-on-web-worker',
'media-parser/parse-media-on-server-worker',
'media-parser/has-been-aborted',
'media-parser/node-reader',
'media-parser/web-reader',
'media-parser/universal-reader',
'media-parser/node-writer',
'media-parser/webcodecs-timescale',
],
},
{
type: 'category',
label: '@remotion/starburst (deprecated)',
link: {
type: 'doc',
id: 'starburst/starburst-api',
},
items: ['starburst/starburst-effect', 'starburst/starburst-component'],
},
{
type: 'category',
label: '@remotion/webcodecs (deprecated)',
link: {
type: 'doc',
id: 'webcodecs/index',
},
items: [
{
type: 'link',
href: '/docs/webcodecs',
label: 'Guide',
},
'webcodecs/convert-media',
'webcodecs/webcodecs-controller',
'webcodecs/get-available-containers',
'webcodecs/can-reencode-audio-track',
'webcodecs/can-reencode-video-track',
'webcodecs/can-copy-audio-track',
'webcodecs/can-copy-video-track',
'webcodecs/default-on-audio-track-handler',
'webcodecs/default-on-video-track-handler',
'webcodecs/get-default-audio-codec',
'webcodecs/get-default-video-codec',
'webcodecs/get-available-audio-codecs',
'webcodecs/get-available-video-codecs',
'webcodecs/convert-audiodata',
'webcodecs/get-partial-audio-data',
'webcodecs/create-audio-decoder',
'webcodecs/create-video-decoder',
'webcodecs/extract-frames',
'webcodecs/extract-frames-on-web-worker',
'webcodecs/rotate-and-resize-video-frame',
'webcodecs/web-fs-writer',
'webcodecs/buffer-writer',
],
},
],
mainSidebar: [
{
type: 'category',
label: 'Getting started',
items: ['getting-started', 'your-first-video'],
},
{
type: 'category',
label: 'Designing visuals',
items: [
'layers',
'transforms',
'assets',
'fonts',
'transitioning',
'motion-blur/index',
'html-in-canvas',
'shaders',
'effects',
'measuring',
'using-randomness',
'animation-math',
'posterization',
'noise-visualization',
'maps',
'light-leaks',
'text-highlights',
'starburst',
],
},
{
type: 'category',
label: 'Create videos with code',
link: {type: 'doc', id: 'create-videos-with-code'},
items: [
'idea',
'components',
'timing',
'animating-properties',
'composing',
],
},
{
type: 'category',
label: 'Adding video',
items: [
'videos/index',
'videos/align-duration',
'videos/sequence',
'videos/transparency',
'videos/video-manipulation',
'color-correction',
'greenscreen',
'videos/accelerated-video',
'videos/jumpcuts',
'videos/different-segments-at-different-speeds',
'video-tags',
'hls',
'videos/prores',
'videos/media-fragments',
'videos/as-threejs-texture',
],
},
{
type: 'category',
label: 'Adding audio',
link: {
type: 'doc',
id: 'using-audio',
},
items: [
'audio/importing',
'audio/trimming',
'audio/delaying',
'audio/volume',
'audio/muting',
'audio/speed',
'audio/pitch',
'audio/from-video',
'audio/visualization',
'audio/sfx',
'audio/exporting',
],
},
{
type: 'category',
label: 'Parameterized videos',
link: {
type: 'doc',
id: 'parameterized-rendering',
},
items: [
'passing-props',
'default-props-inference',
'schemas',
'visual-editing',
'data-fetching',
'dynamic-metadata',
'props-resolution',
'design-systems',
],
},
{
type: 'category',
label: 'Captions',
link: {
type: 'doc',
id: 'captions/index',
},
items: [
'captions/importing',
'captions/transcribing',
'captions/displaying',
'captions/exporting',
],
},
{
type: 'html',
value:
'<hr style="margin-top: 4px; margin-bottom: 4px; border-bottom: none"/>', // The HTML to be rendered
defaultStyle: true, // Use the default menu item styling
},
{
type: 'category',
label: 'Rendering',
link: {
type: 'doc',
id: 'render',
},
items: [
'encoding',
'stills',
'scaling',
'transparent-videos',
'render-as-gif',
'overlay',
'quality',
'dataset-render',
'render-all',
'miscellaneous/video-formats',
'prores',
'artifacts',
'metadata',
'hardware-acceleration',
'parallel-encoding',
'shared-memory-capture',
'webgl',
'hdr',
'sample-rate',
],
},
{
type: 'category',
label: 'Server-side rendering',
link: {
type: 'doc',
id: 'ssr',
},
items: [
'ssr',
'ssr-node',
'docker',
'miscellaneous/linux-single-process',
'gpu',
'miscellaneous/cloud-gpu',
'miscellaneous/cloud-gpu-docker',
'compare-ssr',
'distributed-rendering',
'vercel-sandbox',
'cloudflare-containers',
'azure-container-apps',
],
},
{
type: 'category',
label: 'Client-side rendering',
link: {
type: 'doc',
id: 'client-side-rendering/index',
},
items: [
'client-side-rendering/how-it-works',
'client-side-rendering/limitations',
'client-side-rendering/migration',
'client-side-rendering/html-in-canvas',
'client-side-rendering/page-responsiveness',
'client-side-rendering/cancellation',
{
type: 'link',
href: '/docs/web-renderer',
label: 'API Reference',
},
],
},
{
type: 'category',
label: 'Lambda',
link: {
type: 'doc',
id: 'lambda',
},
items: [
{
type: 'link',
href: '/docs/lambda/api',
label: 'API Reference',
},
'lambda/setup',
'lambda/authentication',
'lambda/permissions',
'lambda/region-selection',
'lambda/aws-china-regions',
'lambda/concurrency',
'lambda/runtime',
'lambda/disk-size',
'lambda/faq',
'lambda/light-client',
'lambda/custom-layers',
'lambda/separate-environments',
'lambda/custom-destination',
'lambda/checklist',
'lambda/webhooks',
'lambda/cancellation',
'lambda/cost-example',
'lambda/autodelete',
{
type: 'category',
label: 'Troubleshooting',
items: [
'lambda/troubleshooting/debug',
'lambda/troubleshooting/permissions',
'lambda/troubleshooting/rate-limit',
'lambda/troubleshooting/unrecognizedclientexception',
'lambda/troubleshooting/bucket-disallows-acl',
'lambda/troubleshooting/security-token',
],
},
{
type: 'category',
label: 'Using without IAM users',
link: {
type: 'doc',
id: 'lambda/without-iam/index',
},
items: [
'lambda/without-iam/index',
'lambda/without-iam/example',
'lambda/without-iam/ec2',
],
},
'lambda/php',
'lambda/go',
'lambda/python',
'lambda/ruby',
'lambda/serverless-framework-integration',
'lambda/supabase',
'lambda/r2',
'lambda/insights',
'lambda/multiple-buckets',
'lambda/data-transfer-cost',
'lambda/how-lambda-works',
'lambda/bucket-naming',
'lambda/optimizing-cost',
'lambda/optimizing-speed',
'lambda/faster-progress-polling',
'lambda/proxy',
'lambda/limits',
'lambda/changelog',
'lambda/upgrading',
'lambda/uninstall',
'lambda/s3-public-access',
'lambda/bucket-security',
'lambda/naming-convention',
],
},
{
type: 'html',
value:
'<hr style="margin-top: 4px; margin-bottom: 4px; border-bottom: none"/>', // The HTML to be rendered
defaultStyle: true, // Use the default menu item styling
},
{
type: 'category',
label: 'Studio',
items: [
'studio/studio',
'studio/open-in-editor',
'studio/shortcuts',
'studio/quick-switcher',
'studio/showing-unmounted-components',
'studio/interactivity',
'studio/interactivity-best-practices',
'studio/make-component-interactive',
'studio/deploy-static',
'studio/deploy-server',
'studio/remotion-dev-new',
'studio/browse-elements',
],
},
{
type: 'category',
link: {
type: 'doc',
id: 'player/index',
},
label: 'Player',
items: [
{
type: 'link',
href: '/docs/player/player',
label: 'API Reference',
},
'player/examples',
'player/scaling',
'player/integration',
'player/autoplay',
'player/current-time',
'troubleshooting/player-flicker',
'player/buffer-state',
'player/premounting',
'player/preloading',
'player/best-practices',
'player/drag-and-drop/index',
'player/custom-controls',
'player/media-keys',
'player/playback-issues',
],
},
{
type: 'category',
label: 'Building apps',
items: [
'brownfield',
'studio-into-app',
'player-into-remotion-project',
'video-uploads',
'validating-user-videos',
'presigned-urls',
'font-picker',
'building-a-timeline',
'multiple-fps',
'electron',
'angular',
'svelte',
'vue',
'buy-a-video-editor',
],
},
{
type: 'category',
label: 'Mediabunny',
link: {
type: 'doc',
id: 'mediabunny/index',
},
items: [
'mediabunny/index',
'mediabunny/new-video',
'mediabunny/metadata',
'mediabunny/frame-rate',
'mediabunny/extract-thumbnail',
'mediabunny/extract-frames',
'mediabunny/can-decode',
'mediabunny/formats',
'mediabunny/webcodecs-bugs',
'mediabunny/version',
],
},
{
type: 'category',
label: 'AI',
link: {
type: 'doc',
id: 'ai/index',
},
items: [
'ai/coding-agents',
'ai/skills',
{
type: 'category',
label: 'Plugins',
link: {
type: 'doc',
id: 'ai/plugins',
},
items: [
'ai/claude-code-plugin',
'ai/codex-plugin',
'ai/cursor-plugin',
'ai/github-copilot-plugin',
'ai/kimi-code-plugin',
],
},
'ai/webmcp',
'ai/bolt',
'ai/chatbot',
'ai/generate',
'ai/dynamic-compilation',
'ai/ai-saas-template',
'ai/mcp',
],
},
{
type: 'category',
label: 'Tooling',
items: [
'tailwind',
'env-variables',
'webpack',
'legacy-babel',
'javascript',
'third-party',
'miscellaneous/typescript-aliases',
'testing',
'figma',
'after-effects',
'export-opentimeline',
],
},
{
type: 'category',
label: 'Elements',
link: {
type: 'doc',
id: 'elements',
},
items: ['elements', 'elements/libraries'],
},
{
type: 'html',
value:
'<hr style="margin-top: 4px; margin-bottom: 4px; border-bottom: none"/>', // The HTML to be rendered
defaultStyle: true, // Use the default menu item styling
},
{
type: 'link',
href: '/docs/api',
label: 'API Reference',
},
{
type: 'link',
label: 'Templates',
href: '/templates',
},
{
type: 'category',
label: 'Snippets',
items: [
'miscellaneous/snippets/freeze-portions',
'miscellaneous/snippets/player-in-iframe',
'miscellaneous/snippets/combine-compositions',
],
},
{
type: 'category',
label: 'FAQ',
items: [
'miscellaneous/render-in-browser',
'miscellaneous/automatic-duration',
'miscellaneous/nextjs',
'vercel',
'miscellaneous/render-on-edge',
'miscellaneous/embed-studio',
'miscellaneous/absolute-paths',
'miscellaneous/live-streaming',
'miscellaneous/pexels',
'lovable-for-motion-graphics',
'miscellaneous/no-remotion-app',
],
},
{
type: 'category',
label: 'Terminology',
link: {
type: 'doc',
id: 'terminology',
},
items: [
'terminology/player',
'terminology/studio',
'terminology/concurrency',
'terminology/input-props',
'terminology/cloud-run-url',
'terminology/service-name',
'terminology/entry-point',
'terminology/root-file',
'terminology/remotion-root',
'terminology/public-dir',
'terminology/serve-url',
'terminology/bundle',
'terminology/sequence',
'terminology/composition',
],
},
{
type: 'category',
label: 'Miscellaneous',
items: [
'security',
'chromium-flags',
'html-in-canvas-bugs',
'miscellaneous/changing-temp-dir',
'miscellaneous/chrome-headless-shell',
'miscellaneous/ffmpeg-license',
'miscellaneous/linux-dependencies',
'gl-options',
'bun',
'deno',
'standalone',
'miscellaneous/emojis',
'miscellaneous/cross-origin-isolation',
'cors-issues',
'react-native',
'detect-remotion',
],
},
'resources',
{
type: 'category',
label: 'Troubleshooting',
items: [
'troubleshooting/debug-failed-render',
'troubleshooting/video-has-no-sound',
'timeout',
'target-closed',
'media-playback-error',
'performance',
'webpack-dynamic-imports',
'non-seekable-media',
'flickering',
'version-mismatch',
'enametoolong',
'slow-method-to-extract-frame',
'wrong-composition-mount',
'staticfile-relative-paths',
'staticfile-remote-urls',
'troubleshooting/background-image',
'troubleshooting/css-animations',
'troubleshooting/nextjs-image',
'troubleshooting/rosetta',
'troubleshooting/loading-root-component',
'troubleshooting/defaultprops-too-big',
'troubleshooting/cannot-save-default-props',
'troubleshooting/could-not-be-parsed-as-a-value-list',
'troubleshooting/broken-fast-refresh',
'troubleshooting/timed-out-page-function',
'troubleshooting/delay-render-proxy',
'troubleshooting/webgl2-context',
'troubleshooting/bundling-bundle',
'troubleshooting/browser-launch',
'troubleshooting/sigkill',
'troubleshooting/subpixel-rendering',
'troubleshooting/could-not-find-executable-to-run',
'troubleshooting/stuck-render',
'troubleshooting/no-frame-found-at-position',
'troubleshooting/font-loading-errors',
],
},
{
type: 'category',
label: 'Get help',
link: {
type: 'doc',
id: 'get-help',
},
items: [
{
type: 'link',
href: '/docs/get-help',
label: 'How to get help',
},
{
type: 'link',
href: 'https://remotion.dev/discord',
label: 'Discord',
},
{
type: 'link',
href: 'https://remotion.dev/discord',
label: 'GitHub Issues',
},
'support',
],
},
{
type: 'category',
label: 'Upgrading',
items: [
'upgrading',
'5-0-migration',
'4-0-migration',
'3-0-migration',
'2-0-migration',
'react-19',
],
},
{
type: 'category',
label: 'Contributing',
items: [
'contributing/index',
'contributing/feature',
'contributing/option',
'contributing/docs',
'contributing/formatting',
'contributing/rust',
'contributing/web-renderer',
'contributing/presentation',
'contributing/sfx',
'contributing/elements',
'authoring-packages',
],
},
{
type: 'category',
label: 'License and terms',
link: {
type: 'doc',
id: 'license',
},
collapsed: true,
items: ['license/pricing', 'license/faq', 'terms', 'telemetry'],
},
{
type: 'category',
label: 'Legal',
link: {
type: 'doc',
id: 'legal',
},
collapsed: true,
items: ['privacy', 'dpa', 'dpia', 'acknowledgements'],
},
{
type: 'category',
label: 'Accessibility',
link: {
type: 'doc',
id: 'accessibility',
},
collapsed: true,
items: ['accessibility/dev', 'accessibility/pro'],
},
{
type: 'html',
value:
'<hr style="margin-top: 4px; margin-bottom: 4px; border-bottom: none"/>', // The HTML to be rendered
defaultStyle: true, // Use the default menu item styling
},
{
type: 'link',
href: '/docs/editor-starter',
label: 'Editor Starter',
className: 'pro-item',
},
{
type: 'link',
href: '/docs/timeline',
label: 'Timeline',
className: 'pro-item',
},
{
type: 'link',
href: '/docs/recorder',
label: 'Recorder',
},
{
type: 'link',
href: '/docs/canvas-capture',
label: 'Canvas Capture',
},
{
type: 'html',
value:
'<hr style="margin-top: 4px; margin-bottom: 4px; border-bottom: none"/>', // The HTML to be rendered
defaultStyle: true, // Use the default menu item styling
},
{
type: 'category',
label: 'Cloud Run',
className: 'unmaintained-item',
link: {
type: 'doc',
id: 'cloudrun',
},
items: [
'cloudrun',
'cloudrun/status',
'cloudrun/setup',
'cloudrun/permissions',
'cloudrun/generate-env',
'cloudrun/region-selection',
'cloudrun/checklist',
'cloudrun/instancecount',
'cloudrun/multiple-buckets',
'cloudrun/limits',
'cloudrun/light-client',
'cloudrun/upgrading',
'cloudrun/uninstall',
],
},
{
type: 'category',
label: 'Media Parser',
link: {
type: 'doc',
id: 'media-parser/index',
},
className: 'deprecated-item',
items: [
{
type: 'link',
href: '/docs/media-parser/parse-media',
label: 'API Reference',
},
'media-parser/metadata',
'media-parser/fields',
'media-parser/samples',
'media-parser/fast-and-slow',
'media-parser/readers',
'media-parser/tags',
'media-parser/download-and-parse',
'media-parser/workers',
'media-parser/format-support',
'media-parser/runtime-support',
'media-parser/pause-resume-abort',
'media-parser/seeking',
'media-parser/webcodecs',
'media-parser/foreign-file-types',
'media-parser/stream-selection',
],
},
{
type: 'category',
label: 'WebCodecs',
className: 'deprecated-item',
link: {
type: 'doc',
id: 'webcodecs/index',
},
items: [
{
type: 'link',
href: '/docs/webcodecs/convert-media',
label: 'API Reference',
},
'webcodecs/convert-a-video',
'webcodecs/rotate-a-video',
'webcodecs/resize-a-video',
'webcodecs/fix-mediarecorder-video',
'webcodecs/resample-audio-16khz',
'webcodecs/track-transformation',
'webcodecs/pause-resume-abort',
'webcodecs/misconceptions',
],
},
],
editorStarterSidebar: [
{
type: 'link',
href: '/docs',
label: 'β Back to the main docs',
},
{
type: 'category',
label: 'Editor Starter',
link: {
type: 'doc',
id: 'editor-starter/index',
},
items: [
'editor-starter/demo',
'editor-starter/before-you-buy',
'editor-starter/buy',
'editor-starter/setup',
'editor-starter/dependencies',
'editor-starter/features',
'editor-starter/state-management',
'editor-starter/tracks-items-assets',
'editor-starter/undo-redo',
'editor-starter/copy-paste',
'editor-starter/cropping',
'editor-starter/snapping',
'editor-starter/fonts',
'editor-starter/asset-uploads',
'editor-starter/asset-cleanup',
'editor-starter/persistance',
'editor-starter/captioning',
'editor-starter/rendering',
'editor-starter/client-side-rendering',
'editor-starter/backend-routes',
'editor-starter/production-checklist',
'editor-starter/features-not-included',
'editor-starter/faq',
'editor-starter/vs-studio',
],
},
],
timelineSidebar: [
{
type: 'link',
href: '/docs',
label: 'β Back to the main docs',
},
{
type: 'category',
label: 'Timeline',
link: {
type: 'doc',
id: 'timeline/index',
},
items: [
'timeline/demo',
'timeline/setup',
'timeline/usage',
'timeline/faq',
'timeline/render',
],
},
],
recorderSidebar: [
{
type: 'category',
label: 'Recorder',
items: [
'recorder/index',
'recorder/is-it-for-me',
'recorder/demo',
'recorder/setup',
'recorder/create',
{
type: 'category',
label: 'Record',
items: [
'recorder/record/index',
'recorder/record/manually',
'recorder/record/delete',
'recorder/record/cropping',
],
},
'recorder/captions',
{
type: 'category',
label: 'Editing',
collapsed: false,
items: [
'recorder/editing/editing',
'recorder/editing/silence-removal',
'recorder/editing/captions',
'recorder/editing/layout',
'recorder/editing/scenes',
'recorder/editing/endcard',
'recorder/editing/transitions',
'recorder/editing/chapters',
'recorder/editing/music',
'recorder/editing/b-roll',
'recorder/editing/cutting-clips',
'recorder/editing/normalizing-audio',
],
},
{
type: 'category',
label: 'Exporting',
collapsed: false,
items: [
'recorder/exporting',
'recorder/lambda-rendering',
'recorder/exporting-subtitles',
],
},
'recorder/source-control',
'recorder/external-recordings',
'recorder/experiments',
{
type: 'category',
label: 'Troubleshooting',
items: [
'recorder/troubleshooting/cannot-read-properties-of-undefined',
],
},
'recorder/roadmap',
'recorder/gear',
'recorder/our-recorder',
'recorder/support',
],
},
],
canvasCaptureSidebar: [
{
type: 'category',
label: 'Canvas Capture',
link: {
type: 'doc',
id: 'canvas-capture/index',
},
items: [
'canvas-capture/installation',
'canvas-capture/agentic-shot-setup',
'canvas-capture/privacy',
],
},
],
browserBundlerSidebar: [
{
type: 'category',
label: '@remotion/browser-bundler',
link: {
type: 'doc',
id: 'browser-bundler/index',
},
items: [
'browser-bundler/create-browser-bundler',
'browser-bundler/load-browser-bundle',
'browser-bundler/create-browser-bundle-runtime',
'browser-bundler/get-browser-composition',
'browser-bundler/create-browser-composition-observer',
],
},
],
sdkSidebar: [
{
type: 'category',
label: '@remotion/sdk',
link: {
type: 'doc',
id: 'sdk/index',
},
items: [
'sdk/canvas',
'sdk/create-canvas-controller',
'sdk/use-canvas-controller',
'sdk/create-canvas-selection-controller',
'sdk/create-canvas-hover-controller',
'sdk/use-canvas-selection',
'sdk/use-canvas-sequence-hover',
'sdk/use-canvas-hover',
'sdk/get-canvas-sequence-node-path-info',
'sdk/get-canvas-sequence-source-location',
'sdk/get-canvas-selection-item-key',
'sdk/get-canvas-sequence-reorder-selection',
'sdk/get-canvas-sequence-reorder-insertion-index',
'sdk/get-canvas-keyframes',
'sdk/get-canvas-keyframe-toggle',
'sdk/start-canvas-keyframe-drag',
'sdk/get-canvas-keyframe-easing-segments',
'sdk/get-canvas-keyframe-easing-change',
'sdk/get-canvas-keyframe-settings',
'sdk/get-canvas-keyframe-settings-change',
'sdk/get-canvas-keyframe-change-override',
'sdk/get-canvas-prop-value-at-frame',
'sdk/get-canvas-keyframe-source-frame',
'sdk/get-canvas-keyframe-display-frame',
],
},
],
codemodsSidebar: [
{
type: 'category',
label: '@remotion/codemods',
link: {
type: 'doc',
id: 'codemods/index',
},
items: [
'codemods/add-canvas-capture-composition',
'codemods/add-composition',
'codemods/add-effect',
'codemods/add-element',
'codemods/add-folder',
'codemods/apply-codemod-changes',
'codemods/create-element',
'codemods/delete-composition',
'codemods/delete-effects',
'codemods/delete-nodes',
'codemods/detach-audio',
'codemods/duplicate-composition',
'codemods/duplicate-effects',
'codemods/duplicate-nodes',
'codemods/get-node-props',
'codemods/get-nodes',
'codemods/move-composition',
'codemods/move-folder',
'codemods/rename-composition',
'codemods/rename-folder',
'codemods/reorder-effect',
'codemods/reorder-nodes',
'codemods/resolve-composition-component',
'codemods/set-composition-default-props',
'codemods/split-sequences',
'codemods/static-file-value',
'codemods/unwrap-folder',
'codemods/unwrap-node',
'codemods/update-composition-metadata',
'codemods/update-effect-keyframes',
'codemods/update-effect-props',
'codemods/update-multiple-node-props',
'codemods/update-node-keyframes',
'codemods/update-node-props',
'codemods/update-visual-controls',
'codemods/wrap-node',
],
},
],
};
export default sidebars;