remotion-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
This skill teaches you how to discover and read current Remotion documentation. If this is not relevant, load Remotion Best Practices instead.
本技能将教你如何查找并阅读最新的Remotion文档。 如果此内容不相关,请改为加载Remotion最佳实践

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.
使用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"
    }
  ]
}
每个搜索结果(hit)都包含一个指向文档页面的
url
字段。

Fetching a page as Markdown

获取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
在任意Remotion文档URL后添加
.md
后缀,即可获取其Markdown源文件(节省令牌消耗):
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.
  1. 使用Algolia搜索你需要的概念或API。
  2. 从结果中选择最相关的URL。
  3. 获取带有
    .md
    后缀的每个URL。
  4. 根据当前文档实现,而非依赖记忆中的API知识。