用途:这是 Remotion 仓库中编写与编辑官方文档的指南,适用于新增文档页、编辑 packages/docs 下的 MDX 文件或撰写文档内容。
主要能力与规范:文档位于 packages/docs/docs,以 .mdx 文件存放。新增页面需创建 .mdx 文件、在 packages/docs/sidebars.ts 中登记,并在 packages/docs 运行 bun render-cards.ts 生成社交预览卡片。若页面属于某个包,可在 frontmatter 加 crumb: '@remotion/package-name' 显示面包屑。每个函数或 API 单独成页,只写公开 API,不引用内部实现。正文中 API 名用反引号并尽量链接,函数与 Hook 带 (),组件带尖括号。API 选项与返回值每个属性单独用 ### 或 #### 标题,不用列表。新增的 API、参数或行为用 <AvailableFrom v="..." /> 标注版本;API 页建议在 ## See also 前加 ## Compatibility 与 <CompatibilityTable>。可选参数在标题加 ?,不写 optional,默认值自然写入描述;CLI 标志不加 ?。
语言与代码:保持简短,链接术语页,避免情绪化措辞,分段,用“你”称呼,不归咎用户,避免“simply”“just”。代码块用 ts 高亮,优先 twoslash 做类型检查,用 // ---cut--- 隐藏导入,示例代码块加 title。
特殊组件:<Step> 每行一个并注意空格与换行;<ExperimentalBadge> 标注实验特性;<Demo type="rect"/> 需在 packages/docs/components/demos/index.tsx 实现。
限制:资料未提供其他平台、收费或效果信息。