guanyang / remotion-docs
Search and fetch Remotion documentation pages
0
SKILL.md1.4 KB
This skill teaches you how to discover and read current Remotion documentation.
If this is not relevant, load [Remotion Best Practices](../SKILL.md) instead.
Searching the docs
Use the Algolia search API to find relevant documentation pages:
POST https://plsduol1ca-dsn.algolia.net/1/indexes/*/queries?x-algolia-api-key=3e42dbd4f895fe93ff5cf40d860c4a85&x-algolia-application-id=PLSDUOL1CA
Content-Type: application/x-www-form-urlencoded
{
"requests": [
{
"query": "<your search query>",
"indexName": "remotion",
"params": "attributesToRetrieve=[\"hierarchy.lvl0\",\"hierarchy.lvl1\",\"hierarchy.lvl2\",\"url\"]&hitsPerPage=10"
}
]
}Each hit contains a url field pointing to the documentation page.
Fetching a page as Markdown
Append .md to any Remotion docs URL to retrieve its Markdown source (saves tokens):
https://www.remotion.dev/docs/use-video-config.md
https://www.remotion.dev/docs/sequence.md
https://www.remotion.dev/docs/lambda/rendermediaonlambda.mdWorkflow
- Search Algolia for the concept or API you need.
- Pick the most relevant URL(s) from the results.
- Fetch each URL with the
.mdsuffix. - Implement using the current documentation rather than memorized API knowledge.