用途
该技能用于发现和阅读 Remotion 的当前文档。当需要了解 Remotion 的某个概念或 API 时,可借助它检索官方文档并获取页面内容,从而基于最新文档进行开发,而不是依赖记忆中的 API 知识。
主要能力
- 文档搜索:使用 Algolia 搜索 API 在 Remotion 文档索引中查找相关页面。
- 结果字段:每条命中结果包含
url字段,指向对应的文档页面;同时可检索hierarchy.lvl0、hierarchy.lvl1、hierarchy.lvl2等标题层级信息。 - Markdown 获取:在任意 Remotion 文档 URL 后追加
.md即可获取该页面的 Markdown 源码,有助于节省 token。
使用方式
搜索文档时,向以下 Algolia 端点发送 POST 请求:
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": "",
"indexName": "remotion",
"params": "attributesToRetrieve=[\"hierarchy.lvl0\",\"hierarchy.lvl1\",\"hierarchy.lvl2\",\"url\"]&hitsPerPage=10"
}
]
}
获取页面 Markdown 时,在文档 URL 后追加 .md,例如:
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。
- 为每个 URL 追加
.md后缀并抓取内容。 - 依据当前文档而非记忆中的 API 知识进行实现。
适用场景
适用于使用 Remotion 进行视频编程开发、需要查阅最新官方文档的场景。如果该技能不相关,可改为加载 Remotion Best Practices。
限制
资料未提供该技能的收费、价格、平台支持范围或效果保证等信息。