本技能教授您如何发现和阅读最新的 Remotion 文档。 若不相关,请改为加载 Remotion 最佳实践。
搜索文档
使用 Algolia 搜索 API 查找相关文档页面:
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"
}
]
}
每个结果都包含一个 url 字段,指向文档页面。
以 Markdown 格式获取页面
在任何 Remotion 文档 URL 后附加 .md 即可获取其 Markdown 源内容(节省 token):
https://www.remotion.dev/docs/use-video-config.md
https://www.remotion.dev/docs/sequence.md
https://www.remotion.dev/docs/lambda/rendermediaonlambda.md
工作流程
- 搜索 Algolia 查找所需的概念或 API。
- 从结果中选择最相关的 URL。
- 使用
.md后缀获取每个 URL 的内容。 - 基于当前文档实现功能,而不是依赖记忆中的 API 知识。