本技能教您如何发现和阅读当前的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": "<您的搜索查询>",
"indexName": "remotion",
"params": "attributesToRetrieve=[\"hierarchy.lvl0\",\"hierarchy.lvl1\",\"hierarchy.lvl2\",\"url\"]&hitsPerPage=10"
}
]
}
每个命中结果包含一个指向文档页面的 url 字段。
获取页面为Markdown
在任何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
工作流程
- 在Algolia中搜索所需的概念或API。
- 从结果中选择最相关的URL。
- 使用
.md后缀获取每个URL的内容。 - 基于当前文档实现,而不是依赖记忆的API知识。