Write and edit Remotion documentation pages with consistent API explanations, clear headings, and TypeScript-checked code examples. Follow the project workflow to add navigation entries, generate social preview cards, and verify that documentation builds successfully.
中文简介正在准备中。当前显示英语简介。
Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
实测评分 未实测
查看安装方法安装前可以查看交给 AI 代理的指令内容。
Documentation lives in packages/docs/docs as .mdx files.
.mdx file in packages/docs/docspackages/docs/sidebars.tsbun render-cards.ts in packages/docs to generate social preview cardsOne API per page: Each function or API should have its own dedicated documentation page. Do not combine multiple APIs (e.g., getEncodableVideoCodecs() and getEncodableAudioCodecs()) on a single page. This is the established pattern throughout the codebase.
Public API only: Documentation is for public APIs only. Do not mention, reference, or compare against internal/private APIs or implementation details. Users should only see what is exported and intended for public use.
Use headings for all fields: When documenting API options or return values, each property should be its own heading. Use ### for top-level properties and #### for nested properties within an options object. Do not use bullet points for individual fields.
Basic syntax highlighting:
```ts
const x = 1;
```
Use twoslash to check snippets against TypeScript:
```ts twoslash
import {useCurrentFrame} from 'remotion';
const frame = useCurrentFrame();
```
Use // ---cut--- to hide setup code - only content below is displayed:
```ts twoslash
import {useCurrentFrame} from 'remotion';
// ---cut---
const frame = useCurrentFrame();
```
```ts twoslash title="MyComponent.tsx"
console.log('Hello');
```
- <Step>1</Step> First step
- <Step>2</Step> Second step
<ExperimentalBadge>
<p>This feature is experimental.</p>
</ExperimentalBadge>
<Demo type="rect"/>
Demos must be implemented in packages/docs/components/demos/index.tsx.
After adding or editing a page, generate social media preview cards:
cd packages/docs && bun render-cards.ts
To check that documentation builds without errors:
# from the monorepo root
bun run build-docs
This validates MDX syntax, twoslash snippets, and broken links.
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Support experimental validation of designed proteins through a cloud laboratory. Prepare and optimize sequences, submit tests for binding, expression, thermal stability, or enzyme activity, track experiment progress, and retrieve results through the API.
中文简介正在准备中。当前显示英语简介。
Analyze time series, observations ordered over time, using aeon in Python. Build classification, prediction, and clustering workflows, detect unusual patterns or changes, and compare methods through an interface compatible with scikit-learn.
中文简介正在准备中。当前显示英语简介。
Create original generative art with p5.js, using code to produce patterns and motion. Receive a written artistic concept and an interactive HTML viewer with adjustable parameters, reproducible random variations, seed navigation, and PNG downloads.
中文简介正在准备中。当前显示英语简介。
Retrieve stock prices, exchange rates, cryptocurrency prices, company financial statements, and economic indicators through the Alpha Vantage API. It also covers historical data, news sentiment, and technical indicators, which summarize price and trading patterns.
中文简介正在准备中。当前显示英语简介。
Design backend systems with clear boundaries between business rules, databases, and external services. Use Clean Architecture, Hexagonal Architecture, and Domain-Driven Design to organize new applications, refactor existing code, and make core logic easier to test.
中文简介正在准备中。当前显示英语简介。
Helps process astronomical data in Python by converting coordinates, units, and time scales, working with FITS observation files, matching object catalogs, and calculating distances using cosmological models.
中文简介正在准备中。当前显示英语简介。