# writing-docs

> Claude/Codex skill by [@remotion-dev](https://omgskills.com/library/remotion-dev/index.md) · 65k stars · Updated 2026-10-18

Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.

Tags: javascript, react, video

## Install

```sh
git clone https://github.com/remotion-dev/remotion /tmp/remotion && ln -s /tmp/remotion/.agents/skills/writing-docs ~/.claude/skills/writing-docs
```

## From README

Writing Remotion Documentation Documentation lives in packages/docs/docs as .mdx files. Adding a new page Create a new .mdx file in packages/docs/docs Add the document to packages/docs/sidebars.ts Write the content following guidelines below Run bun render-cards.ts in packages/docs to 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. 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.

## Links

- HTML page: https://omgskills.com/skills/remotion-dev/remotion/writing-docs/
- GitHub: https://github.com/remotion-dev/remotion
- Author: [@remotion-dev](https://omgskills.com/library/remotion-dev/index.md)

## More from this repo

- [pr-name](https://omgskills.com/skills/remotion-dev/remotion/pr-name/index.md) — Used to review or correct a Remotion pull request title
   - [@remotion-dev](https://omgskills.com/library/remotion-dev/index.md) · 66k stars
- [add-cli-option](https://omgskills.com/skills/remotion-dev/remotion/add-cli-option/index.md) — Used to add a new Remotion CLI or config option by creating an AnyRemotionOption, registering CLI parsing, wiring...
   - [@remotion-dev](https://omgskills.com/library/remotion-dev/index.md) · 66k stars
- [add-effect](https://omgskills.com/skills/remotion-dev/remotion/add-effect/index.md) — Used to add a new effect to @remotion/effects, including implementation, package exports, docs, demos, preview images,...
   - [@remotion-dev](https://omgskills.com/library/remotion-dev/index.md) · 66k stars