deprecate-api

用途：这是 Remotion 关于公共 API 弃用表示方式的参考文档，适用于新增、审查或讨论弃用项时查阅。

主要能力：说明一个仍可用的公共 API 弃用后需在三处体现：公共 TypeScript API 上的 JSDoc @deprecated 注解；文档标题上的删除线格式；标题后紧跟名为 Deprecated 的 info 提示块。该约定适用于函数、组件、hooks、类型、props、options 及其他公共 API。

TypeScript 表示：公共符号带 JSDoc @deprecated 注解，存在替代项时注明替代项并可链接其文档，例如： /**

• @deprecated Use newApi() instead: https://www.remotion.dev/docs/new-api */ export const oldApi = () => {}; 注解应放在使用者接收到的位置；对于再导出或兼容别名，应放在导出的符号上，而非未弃用的实现上。

文档表示：弃用 API 名称的标题使用双波浪线删除线，<AvailableFrom> 保持在删除线之外，例如 # oldApi()<AvailableFrom v="4.0.0" />；prop 或 option 写作 ### oldOption?。frontmatter 标题保持不变；若页面仅依赖 frontmatter 标题，则需显式添加带删除线的标题。标题后紧跟名为 Deprecated 的 info 提示块，存在替代项时指向替代项，例如 :::info Deprecated\nUse newApi() instead.\n:::。

限制：运行时警告、侧边栏徽章、发布说明、移除版本与移除行为目前未纳入 API 弃用标准化范围。已移除的 API 不属于此约定，可能仍为迁移目的保留文档，但已无公共符号可标注。