mcpField
R
remotion-docs

remotion-docs

github.com/remotion-dev开发71.7k117 次安装今天更新
代码仓库

关于 remotion-docs

remotion-docs 是用于查找和阅读最新 Remotion 文档的技能，可帮助开发工作定位相关页面并获取 Markdown 源文档。

主要功能

  1. 01通过 Algolia 搜索文档
  2. 02以 Markdown 获取文档
  3. 03实现时参考当前文档

适用场景

  1. 01查找 Remotion API 文档
  2. 02实现前阅读精简的 Markdown 页面

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/remotion-dev/remotion --skill remotion-docs

安装后在 Claude Code 中输入/remotion-docs确认已加载。

附带文件agents/openai.yaml

详细介绍

本技能将指导你如何查找和阅读最新的 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

工作流

  1. 在 Algolia 中搜索所需的概念或 API。
  2. 从结果中选择最相关的 URL。
  3. 使用 .md 后缀获取每个 URL 的内容。
  4. 参考最新文档进行实现，而不要依赖记忆中的 API 知识。

评论

支持 Markdown