How to use
- Copy the installation command and review the source package before installing it in your own agent environment.
- Check the source document for required tools, credentials and supported hosts.
- Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/remotion-dev/remotion --skill docs-demoBefore you start
- Installation does not include a model subscription, API allowance or permission to access your files.
- Repository stars and installation counts describe activity, not an independent quality or security test.
Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.
Adding an Interactive Demo to Docs
Interactive demos render a Remotion composition inline in documentation pages using @remotion/player. They live in packages/docs/components/demos/.
Effect demos are separate: use <EffectsDemo type="effects-..." /> and register them in packages/docs/components/effects-demos/registry.ts with the real effect schema, not the generic <Demo> options array.
Steps
- Create a component in
packages/docs/components/demos/(e.g.MyDemo.tsx). It should be a standard React component using Remotion hooks likeuseCurrentFrame()anduseVideoConfig().
- Register the demo in
packages/docs/components/demos/types.ts:
- Import the component
- Export a
DemoTypeobject with these fields: id: unique string used in<Demo type="..." />comp: the React componentcompWidth/compHeight: canvas dimensions (e.g. 1280x720)fps: frame rate (typically 30)durationInFrames: animation lengthautoPlay: whether it plays automaticallyoptions: array of interactive controls (can be empty[])
- Add to the demos array in
packages/docs/components/demos/index.tsx:
- Import the demo constant from
./types - Add it to the
demosarray
- Use in MDX with
<Demo type="your-id" />
Options
Options add interactive controls below the player. Each option needs name and optional ('no', 'default-enabled', or 'default-disabled').
Supported types:
type: 'numeric'— slider withmin,max,step,defaulttype: 'boolean'— checkbox withdefaulttype: 'enum'— dropdown withvaluesarray anddefaulttype: 'string'— text input withdefault
Option values are passed to the component as inputProps. Access them as regular React props.
Example registration
export const myDemo: DemoType = {
comp: MyDemoComp,
compHeight: 720,
compWidth: 1280,
durationInFrames: 150,
fps: 30,
id: 'my-demo',
autoPlay: true,
options: [],
};


