Writing Docs
This is a comprehensive style guide for writing Remotion's API documentation, covering everything from file structure to voice and tone. You'll want this when documenting React components, CLI tools, or any public API in the Remotion ecosystem. The guidelines are opinionated in useful ways: one API per page, headings for every parameter instead of bullet lists, type-checked code snippets using twoslash, and strict rules about optional parameters. It includes MDX components for version badges, compatibility tables, and interactive demos. The language section is particularly solid, pushing for brevity and discouraging assumptions about difficulty. If you're maintaining technical docs for a TypeScript library, you could adapt most of this directly.
- skills.sh installs
- 2.9K
- GitHub stars
- 72.1K
- last updated
- Aug 21, 2026
Install
$ npx -y skills add remotion-dev/remotion --skill writing-docs --agent claude-codeInstalls into .claude/skills of the current project.
Files
Writing Remotion Documentation
Documentation lives in packages/docs/docs as .mdx files.
Adding a new page
- Create a new
.mdxfile inpackages/docs/docs - Add the document to
packages/docs/sidebars.ts - Write the content following guidelines below
- Run
bun render-cards.tsinpackages/docsto generate social preview cards
Breadcrumb (crumb): If a documentation page belongs to a package, add crumb: '@remotion/package-name' to the frontmatter. This displays the package name as a breadcrumb above the title.
---
image: https://remotion.media/docs/generated/articles-docs-my-package-my-api.png
title: '<MyComponent>'
crumb: '@remotion/my-package'
---
One API per page: Each function or API should have its own dedicated documentation page. Do not combine multiple APIs (e.g., getEncodableVideoCodecs() and getEncodableAudioCodecs()) on a single page.
Public API only: Documentation is for public APIs only. Do not mention, reference, or compare against internal/private APIs or implementation details.
Sponsors
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/remotion-dev/remotion
- Categories
- Documentation, Generative Media
- First seen
- Apr 16, 2026
More from remotion-dev/remotion
All 13Recommended
More Documentation
adev-writing-guideangular/angularComprehensive writing guide for Angular documentation (adev). Covers Google Technical Writing standards, Angular-specific markdown extensions, code blocks, and 914skills.sh installs
writing-documentation-with-diataxissammcj/agentic-codingApplies the Diataxis framework to create or improve technical documentation. Use when being asked to write high quality tutorials, how-to guides, reference docs627skills.sh installs
doc-writinghuangjia2019/claude-code-engineeringGenerate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.0skills.sh installs
docs-writer-learnreactjs/react.devIf you're contributing to React documentation or building similar technical learning content, this skill knows the patterns cold.0skills.sh installs
docs-demoremotion-dev/remotionAdd an interactive demo to the Remotion documentation. Use when creating a new <Demo> component for docs pages.0skills.sh installswriting-docsremotion-dev/remotionGuides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.0skills.sh installs