Skip to content

fix(docs): clean compose reference heading anchors #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
a-essawy merged 1 commit into from
Jun 22, 2026
Merged

fix(docs): clean compose reference heading anchors #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions jobs/compose.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
</CodeGroup>

<Info>
**Assets:** video, image, text, audio, composition · **Output:** mp4 / webm / gif / mp3 (audio only) / jpg / png (still frame)

Check warning on line 106 in jobs/compose.mdx

View check run for this annotation

Mintlify / Mintlify Validation (rendobar) - vale-spellcheck

jobs/compose.mdx#L106 

Did you really mean 'webm'?

Check warning on line 106 in jobs/compose.mdx

View check run for this annotation

Mintlify / Mintlify Validation (rendobar) - vale-spellcheck

jobs/compose.mdx#L106 

Did you really mean 'gif'?
</Info>

That is the shape of every render. Everything below is one more clip, one more track, or one more field.
Expand Down Expand Up @@ -219,7 +219,7 @@

### Speed

`speed` is a multiplier. Below `1` slows a clip down for a dramatic action beat, above `1` speeds a slow process into a timelapse.

Check warning on line 222 in jobs/compose.mdx

View check run for this annotation

Mintlify / Mintlify Validation (rendobar) - vale-spellcheck

jobs/compose.mdx#L222 

Did you really mean 'timelapse'?

```json
"speed": 0.4
Expand Down Expand Up @@ -248,7 +248,7 @@

### Opacity and blur

`opacity` takes a number or keyframes. Keyframe it from `0` to `1` and back for a clean fade in and out. `blur` softens a clip, useful as a backdrop that keeps overlaid text readable.

Check warning on line 251 in jobs/compose.mdx

View check run for this annotation

Mintlify / Mintlify Validation (rendobar) - vale-spellcheck

jobs/compose.mdx#L251 

Did you really mean 'keyframes'?

Check warning on line 251 in jobs/compose.mdx

View check run for this annotation

Mintlify / Mintlify Validation (rendobar) - vale-spellcheck

jobs/compose.mdx#L251 

Did you really mean 'Keyframe'?

```json
"opacity": [
Expand Down Expand Up @@ -316,7 +316,9 @@

## Reference

### `output`
### Output

The `output` object controls the render target.

| Field | Values |
| --- | --- |
Expand All @@ -327,7 +329,9 @@
| `audioCodec` | `aac`, `opus`, `mp3` (optional) |
| `frameTime` | second of the timeline to capture for `jpg` / `png` (default `0`) |

### Assets (`clip.asset`)
### Assets

A clip's `asset` is one of:

| `type` | Fields |
| --- | --- |
Expand Down Expand Up @@ -361,6 +365,8 @@

`crossfade`, `fade`, `slide` (`direction`: `left` / `right` / `up` / `down`), `zoom`, `none` (hard cut).

### Text style (`text.style`)
### Text style

Fields on a text asset's `style`:

`font`, `size`, `weight` (100..1000), `color`, `align` (`left` / `center` / `right`), `position {x,y}`, `stroke {color,width}`, `background`, `shadow {color,opacity,offsetX,offsetY}`, `animate {type: fade \| slideUp \| slideDown \| slideLeft \| slideRight, duration}`.
Loading