Skip to content

Commit 2a7d9bd

Browse files
committed
docs: rebuild the catalog generator, and show what background removal and HDR do
**The catalog generator destroys hand-written documentation on every run.** It does `rmSync(dir, { recursive: true })` on both catalog folders before regenerating, so any section a human added to a generated page is deleted the next time anyone runs it. There is now a carry-forward pass that reads those sections off the existing pages first and re-emits any heading the template does not own. Note this prevents future loss only — the earlier regeneration in this stack already removed what was there, and it is recoverable from git if wanted. It was also clobbering `docs.json`: rebuilding the Catalog tab dropped its icon and unlinked `catalog/index.mdx` from the sidebar entirely. And 27 of 36 component pages told the reader to "see the comment header in the file" when no such header exists. The generator reads the file now and only says it when true. On presentation: 1,365 table rows across 168 pages became 0. `## Details` was a table whose rows were "Type: Block" and the duration; `## Files` was three columns where most items have exactly one file. Both are one sentence now. The preview leads the page instead of sitting under title, description, tags, a warning and a credit — four of which Mintlify already renders from frontmatter. **Two guides that showed nothing now show the thing.** Background removal plays a real cutout with the matte magnified at the hair edge and at a shoulder a plant overlapped, because those are where matting fails. HDR is the honest one: you cannot show HDR brightness on an SDR page, so it shows the `ffprobe` verdict and a measured round-trip — 4000 nits authored, 4012 back out — and says on screen for all 26 seconds that it is not simulating anything. Both films were checked before publishing: no black or frozen stretches, and read at the real 590px docs column width rather than full size. Nav after regeneration: 307 pages, 0 dangling, 0 redirect collisions.
1 parent 72d4016 commit 2a7d9bd

178 files changed

Lines changed: 5422 additions & 2997 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/catalog/blocks/app-showcase.mdx‎

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,35 @@ title: "App Showcase"
33
description: "Fitness app product showcase with three floating smartphone screens"
44
---
55

6-
`showcase` `app` `3d`
7-
86
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/app-showcase.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/app-showcase.png" autoPlay muted loop playsInline />
97

8+
## Install
9+
10+
```bash Terminal
11+
npx hyperframes add app-showcase
12+
```
13+
14+
That writes one file: `compositions/app-showcase.html`.
15+
16+
## Add it to your video
17+
18+
It runs for 5.5 seconds at 1920×1080. Paste this into your composition:
19+
20+
```html index.html
21+
<div
22+
data-composition-id="app-showcase"
23+
data-composition-src="compositions/app-showcase.html"
24+
data-start="0"
25+
data-duration="5.5"
26+
data-track-index="1"
27+
data-width="1920"
28+
data-height="1080"
29+
></div>
30+
```
31+
32+
Move it in time with `data-start`. Put it on a different timeline row with
33+
`data-track-index`. See [data attributes](/concepts/data-attributes) for the rest.
34+
1035
## Add it to a project
1136

1237
### Ask your agent
@@ -22,20 +47,6 @@ Replace the demo content with mine and match the existing design and timing.
2247
npx hyperframes add app-showcase
2348
```
2449

25-
## Details
26-
27-
| Property | Value |
28-
| --- | --- |
29-
| Type | Block |
30-
| Dimensions | 1920×1080 |
31-
| Duration | 5.5s |
32-
33-
**Installed files**
34-
35-
| File | Target | Type |
36-
| --- | --- | --- |
37-
| `app-showcase.html` | `compositions/app-showcase.html` | hyperframes:composition |
38-
3950
## Use it
4051

4152
Ask your agent to replace the example content, match the project style, and place the block at the right moment in the video.
@@ -51,3 +62,7 @@ Ask your agent to replace the example content, match the project style, and plac
5162
- [Browse the complete Catalog](/catalog)
5263
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
5364
- [Build a richer composition](/go-further)
65+
66+
{/* hf:generated-footer */}
67+
68+
Tagged `showcase` `app` `3d`.

‎docs/catalog/blocks/apple-money-count.mdx‎

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,34 @@ title: "Apple Money Count"
33
description: "Apple-style finance counter that counts from $0 to $10,000, flashes green, and bursts money icons with sound."
44
---
55

6-
`showcase` `finance` `kinetic` `youtube` `sfx`
6+
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/apple-money-count.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/apple-money-count.png" autoPlay muted loop playsInline />
77

8-
Created by [Stronkter](https://x.com/Stronkter).
8+
## Install
99

10-
## Source Prompt
10+
```bash Terminal
11+
npx hyperframes add apple-money-count
12+
```
1113

12-
```text
13-
📷HyperFrames by HeyGen Make me a five-second video of, on a white background, of a Apple-style bold font counting from $0 to $10,000. Once it counts to $10,000, it changes to a green color and the screen also flashes green for a second, and then money icons come out of the $10,000 amount all over the screen and then disappear.
14+
That writes `compositions/apple-money-count.html`, plus 1 supporting file under `assets/`.
15+
16+
## Add it to your video
17+
18+
It runs for 5 seconds at 1920×1080. Paste this into your composition:
19+
20+
```html index.html
21+
<div
22+
data-composition-id="apple-money-count"
23+
data-composition-src="compositions/apple-money-count.html"
24+
data-start="0"
25+
data-duration="5"
26+
data-track-index="1"
27+
data-width="1920"
28+
data-height="1080"
29+
></div>
1430
```
1531

16-
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/apple-money-count.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/apple-money-count.png" autoPlay muted loop playsInline />
32+
Move it in time with `data-start`. Put it on a different timeline row with
33+
`data-track-index`. See [data attributes](/concepts/data-attributes) for the rest.
1734

1835
## Add it to a project
1936

@@ -30,21 +47,6 @@ Replace the demo content with mine and match the existing design and timing.
3047
npx hyperframes add apple-money-count
3148
```
3249

33-
## Details
34-
35-
| Property | Value |
36-
| --- | --- |
37-
| Type | Block |
38-
| Dimensions | 1920×1080 |
39-
| Duration | 5s |
40-
41-
**Installed files**
42-
43-
| File | Target | Type |
44-
| --- | --- | --- |
45-
| `apple-money-count.html` | `compositions/apple-money-count.html` | hyperframes:composition |
46-
| `assets/sfx-production.wav` | `assets/sfx-production.wav` | hyperframes:asset |
47-
4850
## Use it
4951

5052
Ask your agent to replace the example content, match the project style, and place the block at the right moment in the video.
@@ -60,3 +62,17 @@ Ask your agent to replace the example content, match the project style, and plac
6062
- [Browse the complete Catalog](/catalog)
6163
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
6264
- [Build a richer composition](/go-further)
65+
66+
{/* hf:generated-footer */}
67+
68+
Tagged `showcase` `finance` `kinetic` `youtube` `sfx`.
69+
70+
Created by [Stronkter](https://x.com/Stronkter).
71+
72+
<Accordion title="The prompt this was built from">
73+
74+
```text
75+
📷HyperFrames by HeyGen Make me a five-second video of, on a white background, of a Apple-style bold font counting from $0 to $10,000. Once it counts to $10,000, it changes to a green color and the screen also flashes green for a second, and then money icons come out of the $10,000 amount all over the screen and then disappear.
76+
```
77+
78+
</Accordion>

‎docs/catalog/blocks/beat-freeze-cut.mdx‎

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,42 @@ title: "Beat Freeze Cut"
33
description: "A beat-driven speed ramp, freeze-frame hit, and hard-cut sequence for music-led promos and montages."
44
---
55

6-
`transition` `music` `beat-driven` `freeze-frame`
7-
86
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/beat-freeze-cut.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/beat-freeze-cut.png" autoPlay muted loop playsInline />
97

8+
## Install
9+
10+
```bash Terminal
11+
npx hyperframes add beat-freeze-cut
12+
```
13+
14+
That writes one file: `compositions/beat-freeze-cut.html`.
15+
16+
## Add it to your video
17+
18+
It runs for 6 seconds at 1920×1080. Paste this into your composition:
19+
20+
```html index.html
21+
<div
22+
data-composition-id="beat-freeze-cut"
23+
data-composition-src="compositions/beat-freeze-cut.html"
24+
data-start="0"
25+
data-duration="6"
26+
data-track-index="1"
27+
data-width="1920"
28+
data-height="1080"
29+
></div>
30+
```
31+
32+
Move it in time with `data-start`. Put it on a different timeline row with
33+
`data-track-index`. See [data attributes](/concepts/data-attributes) for the rest.
34+
35+
## Change the colors
36+
37+
Set these CSS variables on the block:
38+
39+
- `--bg-color` — Background. Defaults to `#0B0D10`.
40+
- `--accent-color` — Accent. Defaults to `#00E5C7`.
41+
1042
## Add it to a project
1143

1244
### Ask your agent
@@ -22,20 +54,6 @@ Replace the demo content with mine and match the existing design and timing.
2254
npx hyperframes add beat-freeze-cut
2355
```
2456

25-
## Details
26-
27-
| Property | Value |
28-
| --- | --- |
29-
| Type | Block |
30-
| Dimensions | 1920×1080 |
31-
| Duration | 6s |
32-
33-
**Installed files**
34-
35-
| File | Target | Type |
36-
| --- | --- | --- |
37-
| `beat-freeze-cut.html` | `compositions/beat-freeze-cut.html` | hyperframes:composition |
38-
3957
## Use it
4058

4159
Ask your agent to replace the example content, match the project style, and place the block at the right moment in the video.
@@ -51,3 +69,7 @@ Ask your agent to replace the example content, match the project style, and plac
5169
- [Browse the complete Catalog](/catalog)
5270
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
5371
- [Build a richer composition](/go-further)
72+
73+
{/* hf:generated-footer */}
74+
75+
Tagged `transition` `music` `beat-driven` `freeze-frame`.

‎docs/catalog/blocks/blue-sweater-intro-video.mdx‎

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,34 @@ title: "Blue Sweater Intro Video"
33
description: "Warm AI creator intro sequence that resolves into an X follow card for @_blue_sweater_."
44
---
55

6-
`showcase` `ai` `creator` `sfx`
6+
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/blue-sweater-intro-video.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/blue-sweater-intro-video.png" autoPlay muted loop playsInline />
77

8-
Created by [Joe Sai](https://x.com/_blue_sweater_).
8+
## Install
99

10-
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/blue-sweater-intro-video.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/blue-sweater-intro-video.png" autoPlay muted loop playsInline />
10+
```bash Terminal
11+
npx hyperframes add blue-sweater-intro-video
12+
```
13+
14+
That writes `compositions/blue-sweater-intro-video.html`, plus 2 supporting files under `assets/` and `assets/sfx/`.
15+
16+
## Add it to your video
17+
18+
It runs for 12 seconds at 1920×1080. Paste this into your composition:
19+
20+
```html index.html
21+
<div
22+
data-composition-id="blue-sweater-intro-video"
23+
data-composition-src="compositions/blue-sweater-intro-video.html"
24+
data-start="0"
25+
data-duration="12"
26+
data-track-index="1"
27+
data-width="1920"
28+
data-height="1080"
29+
></div>
30+
```
31+
32+
Move it in time with `data-start`. Put it on a different timeline row with
33+
`data-track-index`. See [data attributes](/concepts/data-attributes) for the rest.
1134

1235
## Add it to a project
1336

@@ -24,22 +47,6 @@ Replace the demo content with mine and match the existing design and timing.
2447
npx hyperframes add blue-sweater-intro-video
2548
```
2649

27-
## Details
28-
29-
| Property | Value |
30-
| --- | --- |
31-
| Type | Block |
32-
| Dimensions | 1920×1080 |
33-
| Duration | 12s |
34-
35-
**Installed files**
36-
37-
| File | Target | Type |
38-
| --- | --- | --- |
39-
| `blue-sweater-intro-video.html` | `compositions/blue-sweater-intro-video.html` | hyperframes:composition |
40-
| `assets/joe-sai-avatar.png` | `assets/joe-sai-avatar.png` | hyperframes:asset |
41-
| `assets/sfx/integrated-melodic-tech-mix.wav` | `assets/sfx/integrated-melodic-tech-mix.wav` | hyperframes:asset |
42-
4350
## Use it
4451

4552
Ask your agent to replace the example content, match the project style, and place the block at the right moment in the video.
@@ -55,3 +62,9 @@ Ask your agent to replace the example content, match the project style, and plac
5562
- [Browse the complete Catalog](/catalog)
5663
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
5764
- [Build a richer composition](/go-further)
65+
66+
{/* hf:generated-footer */}
67+
68+
Tagged `showcase` `ai` `creator` `sfx`.
69+
70+
Created by [Joe Sai](https://x.com/_blue_sweater_).

‎docs/catalog/blocks/camcorder-hud.mdx‎

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,35 @@ title: "Camcorder HUD"
33
description: "Responsive REC, battery, editable date placeholder, and timeline-driven counter overlay for creator-camera and camcorder treatments"
44
---
55

6-
`camcorder` `camera` `recording` `hud` `overlay` `creator` `media-treatment-overlay`
7-
86
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/camcorder-hud.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/camcorder-hud.png" autoPlay muted loop playsInline />
97

8+
## Install
9+
10+
```bash Terminal
11+
npx hyperframes add camcorder-hud
12+
```
13+
14+
That writes one file: `compositions/camcorder-hud.html`.
15+
16+
## Add it to your video
17+
18+
It runs for 4 seconds at 1920×1080. Paste this into your composition:
19+
20+
```html index.html
21+
<div
22+
data-composition-id="camcorder-hud"
23+
data-composition-src="compositions/camcorder-hud.html"
24+
data-start="0"
25+
data-duration="4"
26+
data-track-index="1"
27+
data-width="1920"
28+
data-height="1080"
29+
></div>
30+
```
31+
32+
Move it in time with `data-start`. Put it on a different timeline row with
33+
`data-track-index`. See [data attributes](/concepts/data-attributes) for the rest.
34+
1035
## Add it to a project
1136

1237
### Ask your agent
@@ -22,20 +47,6 @@ Replace the demo content with mine and match the existing design and timing.
2247
npx hyperframes add camcorder-hud
2348
```
2449

25-
## Details
26-
27-
| Property | Value |
28-
| --- | --- |
29-
| Type | Block |
30-
| Dimensions | 1920×1080 |
31-
| Duration | 4s |
32-
33-
**Installed files**
34-
35-
| File | Target | Type |
36-
| --- | --- | --- |
37-
| `camcorder-hud.html` | `compositions/camcorder-hud.html` | hyperframes:composition |
38-
3950
## Use it
4051

4152
Ask your agent to replace the example content, match the project style, and place the block at the right moment in the video.
@@ -51,3 +62,7 @@ Ask your agent to replace the example content, match the project style, and plac
5162
- [Browse the complete Catalog](/catalog)
5263
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
5364
- [Build a richer composition](/go-further)
65+
66+
{/* hf:generated-footer */}
67+
68+
Tagged `camcorder` `camera` `recording` `hud` `overlay` `creator` `media-treatment-overlay`.

0 commit comments

Comments
 (0)