Upload Element Previews
- Identify the Element slug. Ask if it is ambiguous.
- Choose the source:
- Use
renderfor fresh files in.element-previews. - Use
submissionfor committed files instatic/elements.
- Use
- Upload the previews:
cd packages/docs
bun run upload-element-preview \
--element=<category>/<slug> \
--source=<render|submission>
To refresh an already-published preview, add --overwrite. The uploader accepts it only when the Element definition already uses the exact expected https://remotion.media/elements/... PNG and MP4 URLs.
- For a new preview, replace
image,posterUrl, andvideoUrlwith the printedremotion.mediaURLs. An overwritten preview keeps its existing URLs. - If using
submission, delete the local review assets. If usingrender, leave.element-previewsuncommitted. - Commit and push when the work belongs on a branch.