editor/docs/examples/README.md
konstantin-paulus 7372c40429 Update documentation references and refactor knowledge handling
- Changed references from `knowledge` to `docs` in README and various files to reflect the new documentation structure.
- Updated `.gitignore` to exclude the `docs` directory instead of `knowledge`.
- Refactored `forge.config.ts` and `main.ts` to utilize the new `docs` directory for staging resources.
- Introduced `stage-docs.mjs` script to manage the staging of documentation files.
- Added new documentation files under `docs/`, including `INSTRUCTIONS.md`, brand guidelines, and design specifications.
- Removed outdated `knowledge` related tests and files to streamline the codebase.
2026-09-11 20:33:57 +02:00

3.0 KiB

Examples

Self-contained compositions demonstrating the JSX API (see reference/jsx). Each one is a whole project entry file: it default-exports a component rendering a <stage> with one <scene> in it. To run one, copy it into a project folder as the entry and open that folder — from a shell:

cp examples/01-basics.tsx ~/Projects/basics/index.tsx
dapi open ~/Projects/basics
Example Shows
01-basics.tsx <stage> / <scene>, <sequence> with a dissolve, <video>, <audio>, <image>, <text> titles from data via <For>, <animation> children
02-genai.tsx multi-stage generation: generate.image refs feeding generate.video, TTS voiceover, generated ambience, <captions>
03-ticker.tsx declarative animation: useTicker + createMemo derived values driving props
04-html-in-canvas.tsx <htmlPaint>: an AI prompt box as real DOM, typed out from the playhead
05-anime-timeline.tsx anime.js timeline seeked from useTicker, driving an ECS node and <html> content in lockstep
06-three.tsx three.js WebGL renderer owning a <surface>, glTF model loaded over the network
07-webgpu.tsx raw WebGPU on a <surface>: a triangle whose colors cycle with composition time
08-shader-paint.tsx <shaderPaint> post-processing a <video>: WGSL chromatic aberration + vignette, uniforms patchable live
09-inspect-variables.tsx @inspect variables: annotated top-level consts becoming sidebar controls, values written back into the source
10-typegpu.tsx TypeGPU on a <surface>: shaders written in TypeScript ('use gpu'), compiled through the project's own babel config
11-redraw.tsx Redraw on a <surface>: the docs' Hello World write-on stroke, a vendored-tarball package driven by composition time; the surface spans one animation cycle, @inspect variables tune it, and useResolution keeps it sharp at any export size

Requirements: 02-genai.tsx consumes generation credits (results are cached per session); 01-basics.tsx, 06-three.tsx, and 08-shader-paint.tsx fetch remote media. 10-typegpu.tsx and 11-redraw.tsx need packages installed in the project folder and a babel config next to the entry — the commands are in their header comments. 11-redraw.tsx additionally needs the redraw tarball vendored into the project (Redraw is in technical preview).

Typecheck with tsc -p examples --noEmit (part of npm run check). 06-three.tsx needs three installed to typecheck, 10-typegpu.tsx needs typegpu and @typegpu/noise, and 11-redraw.tsx needs redraw and typegpu; none of these are dependencies of this repo.