Apply consistent deprecation notices to public Remotion APIs that remain available. Use TypeScript annotations and documentation formatting to mark APIs as no longer recommended, identify replacements, and review whether both representations follow the conventions.
中文简介正在准备中。当前显示英语简介。
Reference for how deprecation of public Remotion APIs is represented in TypeScript source and documentation. Use when adding, reviewing, or discussing a deprecation of a function, component, hook, type, prop, option, or other public API that remains available.
安装前可以查看交给 AI 代理的指令内容。
Deprecation of a public API that remains available is represented in three places:
@deprecated annotation on the public TypeScript API.info admonition named Deprecated directly after that heading.These conventions apply to functions, components, hooks, types, props, options, and other public APIs.
The public symbol carries a JSDoc @deprecated annotation. The annotation states the replacement when one exists and may link to its documentation.
/**
* @deprecated Use `newApi()` instead: https://www.remotion.dev/docs/new-api
*/
export const oldApi = () => {};
The annotation belongs where consumers receive it. For a re-export or compatibility alias, this is the exported symbol rather than the non-deprecated implementation.
The deprecated API name in its heading uses double-tilde strikethrough. <AvailableFrom> remains outside the strikethrough.
# ~~oldApi()~~<AvailableFrom v="4.0.0" />
For a prop or option:
### ~~`oldOption?`~~
The frontmatter title remains unchanged. A page that otherwise relies only on its frontmatter title has an explicit struck-through heading.
An info admonition named Deprecated appears directly after the heading and points to the replacement when one exists.
:::info Deprecated
Use [`newApi()`](/docs/new-api) instead.
:::
Runtime warnings, sidebar badges, release notes, removal versions, and removal behavior are not currently standardized as part of API deprecation.
Removed APIs are outside this convention. They may remain documented for migration purposes, but they no longer have a public symbol to annotate.
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Add a reported Remotion bug to the bugs API with its affected versions, a short title, and upgrade guidance. Follow the existing entry format and place the new record first so recent bugs appear at the top.
中文简介正在准备中。当前显示英语简介。
Add a Remotion command-line or configuration option, or convert a hardcoded flag into a shared option definition. Connect parsing, configuration setters, help entries, and generated documentation so the option is consistently available and documented.
中文简介正在准备中。当前显示英语简介。
Add a new effect to @remotion/effects, including its implementation, package entry points, documentation, interactive demo, and preview images. Follow the package conventions and verify the changes with tests, formatting checks, and builds.
中文简介正在准备中。当前显示英语简介。
Add a person to the Remotion experts page by placing their portrait, entering their profile and contact links, and generating an expert card image. The instructions specify file locations, profile fields, and how to verify card generation.
中文简介正在准备中。当前显示英语简介。
Create a new @remotion package within the Remotion monorepo, a repository containing multiple packages. Set up its files, register it across the project, and prepare documentation, usage examples, and build configuration.
中文简介正在准备中。当前显示英语简介。
Add a new sound effect to @remotion/sfx, from registering the audio file to exporting its URL and documenting its use. The workflow covers playback examples, attribution, navigation entries, waveform generation, and the package build.
中文简介正在准备中。当前显示英语简介。