docs-demo

Embed interactive Remotion demos into documentation pages via a Demo component.

55.9k|4.2k|Updated Jun 23, 2020
One-click install
npx skills add https://github.com/remotion-dev/remotion --skill docs-demo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-demo
Source: https://github.com/remotion-dev/remotion/tree/main/.claude/skills/docs-demo
Command: npx skills add https://github.com/remotion-dev/remotion --skill docs-demo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps documentation teams embed interactive Remotion demos into their pages, enabling dynamic previews without leaving the docs.

Core Features & Use Cases

  • Inline Demos: Add inline Remotion components to documentation pages for live previews.
  • Demo Registry: Standardized registration of demos in the docs codebase (packages/docs/components/demos) so they render with a Demo component.
  • Use Case: A developer adds a new Demo component, registers it in the demos/types.ts, and renders it in an MDX doc with Demo type.

Quick Start

Create a new demo component in packages/docs/components/demos/, register it in the demos/types.ts file, import and render it in docs MDX using a Demo type.

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 into documentation pages?

To embed interactive Remotion demos, create a component in packages/docs/components/demos, register it in demos/types.ts, and render it in your MDX docs using the Demo type.

What is the process for registering a new demo component in a docs site?

Registering a new demo component requires placing the file in packages/docs/components/demos, adding its type definition to demos/types.ts, and using frontmatter-driven discovery for name and description attributes.

Can I add live React component previews directly inline within MDX documentation?

Yes, you can add live React component previews inline within MDX documentation by registering the component as a Demo type and rendering it directly on the page.

Does embedding interactive demos in docs require a separate demo registry?

Yes, embedding interactive demos requires a structured demo registry where components are registered in a types.ts file to ensure correct rendering with the Demo component.

What's the best way to showcase Remotion components in documentation without leaving the page?

The best way to showcase Remotion components without leaving the page is using inline demos that provide dynamic previews directly within the documentation environment.