用途
remotion-docs 是一个文档检索类技能,用于发现和阅读当前的 Remotion 官方文档。它的核心目标是让开发者在编写 Remotion 代码前,先查到与所需概念或 API 对应的最新文档页面,再依据文档内容实现,而不是依赖记忆中的 API 知识。资料同时提示:如果该技能与本任务不相关,可改用 Remotion Best Practices。
主要能力
- 文档搜索:使用 Algolia 搜索 API 在 Remotion 文档索引(indexName 为 remotion)中查询,返回的每条命中结果包含 url 字段,指向对应文档页面。搜索请求还指定只取回部分层级字段(hierarchy.lvl0、hierarchy.lvl1、hierarchy.lvl2、url),每页返回 10 条。
- Markdown 获取:在任何 Remotion 文档 URL 后追加 .md 即可取得该页的 Markdown 源文,资料说明这样做可以节省 token。给出的示例包括 use-video-config、sequence 和 lambda/rendermediaonlambda 三个页面。
使用方式
资料给出的工作流为:
- 用 Algolia 搜索需要的概念或 API;
- 从结果中挑选最相关的 URL;
- 给每个 URL 加上 .md 后缀并抓取内容;
- 依据当前文档进行实现。
搜索请求的要点如下(保留原始内容,不作改动): 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
请求体为 JSON,包含 requests 数组,其中 query 为空字符串、indexName 为 remotion、params 指定 attributesToRetrieve 与 hitsPerPage=10。
获取 Markdown 的示例 URL: https://www.remotion.dev/docs/use-video-config.md https://www.remotion.dev/docs/sequence.md https://www.remotion.dev/docs/lambda/rendermediaonlambda.md
适用场景
适合在开发 Remotion 相关项目、需要查找某个 API 或概念的当前用法时使用,尤其是在不确定 API 是否已变化的情况下,先搜索再读文档可降低用错接口的风险。
限制
资料未提供该技能的安装命令、运行环境要求、支持的平台、收费方式或效果说明,这些信息暂未提供。技能本身不生成或修改代码,其作用范围限于文档检索与读取。