mcpField
R
remotion-docs

remotion-docs

github.com/remotion-devDevelopment71.7k117 installsUpdated today
Repository

About remotion-docs

remotion-docs is a skill for finding and reading current Remotion documentation. It guides development work toward relevant docs and their Markdown sources.

Key features

  1. 01Search documentation with Algolia
  2. 02Fetch documentation as Markdown
  3. 03Use current docs during implementation

Use cases

  1. 01Find documentation for a Remotion API
  2. 02Read concise Markdown pages before implementation

Install

Copy the command and run it in a terminal.

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

After installing, type/remotion-docsin Claude Code to confirm it loaded.

Bundled filesagents/openai.yaml

Details

From the project README

This skill teaches you how to discover and read current Remotion documentation. If this is not relevant, load Remotion Best Practices 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.md

Workflow

  1. Search Algolia for the concept or API you need.
  2. Pick the most relevant URL(s) from the results.
  3. Fetch each URL with the .md suffix.
  4. Implement using the current documentation rather than memorized API knowledge.

Comments

Markdown supported