docs-demo

Embed interactive Remotion demos in MDX documentation pages.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Animesh-Kr/claude-skills --skill docs-demo-animesh-kr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-demo
Source: https://github.com/Animesh-Kr/claude-skills/tree/main/remotion-main/.claude/skills/docs-demo
Command: npx skills add https://github.com/Animesh-Kr/claude-skills --skill docs-demo-animesh-kr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Interactive demos render a Remotion composition inline in documentation pages using @remotion/player. They live in packages/docs/components/demos/.

Core Features & Use Cases

  • Create a component in packages/docs/components/demos/ (e.g. MyDemo.tsx) using Remotion hooks.
  • Register the demo in packages/docs/components/demos/types.ts with id, comp, compWidth / compHeight, fps, durationInFrames, autoPlay, options.
  • Add to the demos array in packages/docs/components/demos/index.tsx and use in MDX with <Demo type="your-id" />.

Quick Start

Create a demo component in packages/docs/components/demos/, register it in packages/docs/components/demos/types.ts, include it in packages/docs/components/demos/index.tsx, and render it in MDX with <Demo type="your-id"/>.

Frequently Asked Questions about docs-demo

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I embed interactive Remotion demos in documentation?

To embed interactive Remotion demos in docs, create a React component using Remotion hooks, register it with a DemoType entry, and render it in MDX using the <Demo> tag.

What properties are required when registering a Remotion demo component?

Registering a Remotion demo component requires a DemoType entry specifying id, comp, compWidth, compHeight, fps, durationInFrames, autoPlay, and options to ensure consistent playback behavior.

Can I use the Remotion player to autoplay multiple demos on a single page?

Yes, you can configure multiple Remotion demos on a single page by adding each component to the demos array and setting the autoPlay property within their respective DemoType registrations.

What is the best way to integrate an interactive video demo into MDX?

The best way to integrate an interactive video demo into MDX is to wire a standard Remotion player component through a registered id and invoke it using the <Demo type="your-id" /> MDX usage tag.

Do I need to configure fps and sizing for each individual Remotion demo?

You must configure fps, compWidth, and compHeight for each individual Remotion demo within the DemoType entry in types.ts to ensure consistent sizing and playback across the documentation site.