Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
83%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
Passed
No findings from the security scan
Documentation lives in packages/docs/docs as .mdx files.
.mdx file in packages/docs/docspackages/docs/sidebars.tsbun render-cards.ts in packages/docs to generate social preview cardsBreadcrumb (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.
API names in prose: Put API names in backticks, and link them if a docs page exists. Function and hook names should include (), for example useVideoConfig(), not useVideoConfig or useVideoConfig. Components should include angle brackets, for example <Player> or <Audio>.
Use headings for all fields: When documenting API options or return values, each property should be its own heading. Use ### for top-level properties and #### for nested properties within an options object. Do not use bullet points for individual fields.
Version indicators: If an API, feature, parameter, or behavior was added in a specific version, add <AvailableFrom> to the heading of the page, section, or field where the reader first needs to know it. For example: # prefetch()<AvailableFrom v="4.0.0" />. Only use <AvailableFrom> in headings; in prose, lists and tables, write the version as plain text, for example "From v4.0.540, ...".
Compatibility tables: API pages should ideally include a ## Compatibility section with <CompatibilityTable> before ## See also.
Sidebar order: When adding or moving docs in packages/docs/sidebars.ts, inspect the surrounding entries and match the ordering logic already used there. If a section is alphabetical, place the new entry alphabetically; if it is grouped by workflow or importance, place it consistently with that grouping. Do not leave new additions as one-off outliers.
A reader of a guide or an example hasn't decided to do anything yet. Don't assign them an intent, an action or knowledge with "you".
userSelect: 'none' to disable selection." (explaining code that is already shown)userSelect: 'none' disables selection."npx remotion lambda sites create".Basic syntax highlighting:
```ts
const x = 1;
```Use twoslash to check snippets against TypeScript:
```ts twoslash
import {useCurrentFrame} from 'remotion';
const frame = useCurrentFrame();
```Use // ---cut--- to hide setup code - only content below is displayed:
```ts twoslash
import {useCurrentFrame} from 'remotion';
// ---cut---
const frame = useCurrentFrame();
```Always add a title to code fences that show example usage:
```ts twoslash title="MyComponent.tsx"
console.log('Hello');
```Keep one <Step> per line and add a space after </Step>. Use an explicit line break (<br/> or <br />) when consecutive steps should appear on separate lines. Do not add Markdown bullet markers solely to wrap steps in a <ul>.
<Step>1</Step> First step<br />
<Step>2</Step> Second step<ExperimentalBadge>
<p>This feature is experimental.</p>
</ExperimentalBadge><Demo type="rect"/>Demos must be implemented in packages/docs/components/demos/index.tsx. See the docs-demo skill for details on adding new demos.
Use to indicate when a feature or parameter was added. No import needed - it's globally available.
Only place <AvailableFrom> at the end of a heading. Never use it inside a sentence, list item or table cell - the badge looks out of place there. If a behavior changed in a specific version and does not have its own heading, write the version as plain text instead:
From v4.0.540, you can override the name.Do not do this:
From <AvailableFrom v="4.0.540" inline />, you can override the name.For page-level version indicators, use an # h1 heading with <AvailableFrom> inline so it appears next to the title (not below it). Use < and > to escape angle brackets in component names:
# <MyComponent><AvailableFrom v="4.0.123" /># @remotion/my-package<AvailableFrom v="4.0.123" />For section headings:
## Saving to another cloud<AvailableFrom v="3.2.23" />Use to indicate which runtimes and environments a component or API supports. No import needed. Place it in a ## Compatibility section before ## See also.
Available boolean props: chrome, firefox, safari, player, studio, clientSideRendering, serverSideRendering. Set to true (supported) or {false} (not supported).
Set to empty string "" for not applicable if this is a frontend API: nodejs="", bun="", serverlessFunctions="".
Use hideServers to hide the Node.js/Bun/serverless row if this is a frontend API.
## Compatibility
<CompatibilityTable chrome firefox safari nodejs="" bun="" serverlessFunctions="" clientSideRendering={false} serverSideRendering player studio hideServers />For optional parameters in API documentation:
? to the heading - this indicates the parameter is optional
--> Don't do it if it is a CLI flag (beginning with --) - CLI flags are always optional_optional_ text - the ? suffix is sufficient### onError?
Called when an error occurs. Default: errors are thrown.Do NOT do this:
### onError?
_optional_
Called when an error occurs.When a parameter is both optional and was added in a specific version:
### onError?<AvailableFrom v="4.0.50" />
Called when an error occurs.If a parameter became optional in a specific version (was previously required), write the version as plain text:
### codec?
Optional since v5.0.0. Previously required.After adding or editing a page, generate social media preview cards:
cd packages/docs && bun render-cards.tsThe command uploads cards to https://remotion.media/docs/generated/ and
requires R2 credentials from the docs environment or bun --env-file.
Commit the hosted image: frontmatter; local generated PNGs are ignored.
To replace an existing card, pass --overwrite=<composition-id>.
When asked to audit or streamline docs, scan for:
<AvailableFrom> indicators for APIs, features, options, parameters, or behaviors introduced in a specific version()## Compatibility section with <CompatibilityTable><Step> formattingremotion-dev/remotion
cc7879e
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.