Add comprehensive Captions documentation section #5455
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Co-authored-by: JonnyBurger <1629785+JonnyBurger@users.noreply.github.com>
…n frontmatter Co-authored-by: JonnyBurger <1629785+JonnyBurger@users.noreply.github.com>
Copilot
AI
changed the title
Copilot finished work on behalf of
JonnyBurger
June 21, 2025 08:21
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new comprehensive "Captions" documentation section to help users work with captions in Remotion videos.
What's Added
New Documentation Section
/docs/captions-guide/) - Introduction to Remotion's caption ecosystem and theCaptiontype/docs/captions-guide/importing) - Complete guide for importing existing captions from SRT files, JSON data, and custom formats/docs/captions-guide/generating) - Comprehensive coverage of all three caption generation packages with comparison and examples/docs/captions-guide/examples) - Practical implementation examples including animated captions, TikTok-style captions, and word-by-word highlightingKey Features Covered
Importing Captions:
fetch()with SRT files and theparseSrt()functionCaptiontypeGenerating Captions:
@remotion/install-whisper-cpp- Local transcription with Whisper.cpp@remotion/whisper-web- Browser-based transcription using WebAssembly@remotion/openai-whisper- Cloud-based transcription with OpenAI APICaptiontype structurePractical Examples:
createTikTokStyleCaptions()Integration
The documentation provides both beginner-friendly introductions and advanced implementation details, making it easy for users to get started with captions while also providing comprehensive reference material.
Fixes #5454.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.