diff --git a/DOCS_GUIDELINES.md b/DOCS_GUIDELINES.md index 89a915ba9..c74e588df 100644 --- a/DOCS_GUIDELINES.md +++ b/DOCS_GUIDELINES.md @@ -64,11 +64,13 @@ Title ### Always annotate code blocks -```mdx -```html index.html -
-```​ -``` +`````mdx +````html index.html +
```​
+```` +````` + +````` The filename after the language tag tells readers where the code goes. @@ -97,32 +99,27 @@ npx hyperframes dev ### Use CodeGroup for multi-platform commands -```mdx +````mdx -```bash macOS -brew install ffmpeg -```​ -```bash Ubuntu -sudo apt install ffmpeg -```​ + ```bash macOS brew install ffmpeg ```​ ```bash Ubuntu sudo apt install ffmpeg ```​ -``` +````` ## Mintlify Components — When to Use -| Component | Use When | -|-----------|----------| -| `` | Sequential setup or tutorial instructions | -| `` | Same action across platforms/languages | -| `` | Alternative approaches with equal weight | -| `` / `` | Navigation to related pages, next steps | -| `` | FAQ or optional detail that would bloat the page | -| `` | Non-obvious behavior the reader should know | -| `` | Something that will break if ignored | -| `` | Helpful shortcut or best practice | -| `` | Context that aids understanding | -| `` | File/directory structure | -| `` | Screenshots or diagrams with captions | +| Component | Use When | +| ---------------------- | ------------------------------------------------ | +| `` | Sequential setup or tutorial instructions | +| `` | Same action across platforms/languages | +| `` | Alternative approaches with equal weight | +| `` / `` | Navigation to related pages, next steps | +| `` | FAQ or optional detail that would bloat the page | +| `` | Non-obvious behavior the reader should know | +| `` | Something that will break if ignored | +| `` | Helpful shortcut or best practice | +| `` | Context that aids understanding | +| `` | File/directory structure | +| `` | Screenshots or diagrams with captions | ### Callout budget: max 2-3 per page diff --git a/bun.lock b/bun.lock index ad88feeff..dbbcfed9f 100644 --- a/bun.lock +++ b/bun.lock @@ -8,6 +8,7 @@ "@commitlint/cli": "^20.5.0", "@commitlint/config-conventional": "^20.5.0", "@types/node": "^25.0.10", + "@typescript/native-preview": "^7.0.0-dev.20260323.1", "concurrently": "^8.2.0", "knip": "^6.0.3", "lefthook": "^2.1.4", @@ -665,6 +666,22 @@ "@types/yauzl": ["@types/yauzl@2.10.3", "", { "dependencies": { "@types/node": "22.19.15" } }, "sha512-oJoftv0LSuaDZE3Le4DbKX+KS9G36NzOeSap90UIK0yMA/NhKJhqlSGtNDORNRaIbQfzjXDrQa0ytJ6mNRGz/Q=="], + "@typescript/native-preview": ["@typescript/native-preview@7.0.0-dev.20260323.1", "", { "optionalDependencies": { "@typescript/native-preview-darwin-arm64": "7.0.0-dev.20260323.1", "@typescript/native-preview-darwin-x64": "7.0.0-dev.20260323.1", "@typescript/native-preview-linux-arm": "7.0.0-dev.20260323.1", "@typescript/native-preview-linux-arm64": "7.0.0-dev.20260323.1", "@typescript/native-preview-linux-x64": "7.0.0-dev.20260323.1", "@typescript/native-preview-win32-arm64": "7.0.0-dev.20260323.1", "@typescript/native-preview-win32-x64": "7.0.0-dev.20260323.1" }, "bin": { "tsgo": "bin/tsgo.js" } }, "sha512-e8rnqL5I4DUSjiy6jiWqYFKcgKq8tC4S+uEmJwWiyTgSIGDhaRUujJ2pb6EXmi+NPeXoES6vIG7e9BsEV0WSow=="], + + "@typescript/native-preview-darwin-arm64": ["@typescript/native-preview-darwin-arm64@7.0.0-dev.20260323.1", "", { "os": "darwin", "cpu": "arm64" }, "sha512-C3tQdgMaYn57xzRUWek+zNKMiP0z9j7fqbCjr0wlyiLNIh5jMwDArjBDKHlqSu58FKvZg7baqbqB5Mcepb3s6w=="], + + "@typescript/native-preview-darwin-x64": ["@typescript/native-preview-darwin-x64@7.0.0-dev.20260323.1", "", { "os": "darwin", "cpu": "x64" }, "sha512-YE6pD4wdMqNgaBkXicQBLFwABOEmLxDclSM7grl0fw4cQSbfVwFCbSlwFDkmISKdmsgtWdYeMohrsTU710ufpg=="], + + "@typescript/native-preview-linux-arm": ["@typescript/native-preview-linux-arm@7.0.0-dev.20260323.1", "", { "os": "linux", "cpu": "arm" }, "sha512-6zFO/SF9Gu8rtRyEt1b10TNapQGq5b/wUjCLG14675n155r4EO3JFMgnltBViV2Eatnq7G+bXD65BUBk7Ixyhw=="], + + "@typescript/native-preview-linux-arm64": ["@typescript/native-preview-linux-arm64@7.0.0-dev.20260323.1", "", { "os": "linux", "cpu": "arm64" }, "sha512-Jzr2gBY0ifA3XejAl7kPeHLT72JFBfzLSafOAQbANh5Iag02uPl99k8ORMfKREbYgEMMOzqPpe+r6eaKy+VEfw=="], + + "@typescript/native-preview-linux-x64": ["@typescript/native-preview-linux-x64@7.0.0-dev.20260323.1", "", { "os": "linux", "cpu": "x64" }, "sha512-UvsQdVI/LayXTowltMgtg2GHU/a/lcuOYbaAYm9+/nvgIs01VqVo0s1/lTSNBzepEk0y1EOYQ6SIsRM9lLGHxA=="], + + "@typescript/native-preview-win32-arm64": ["@typescript/native-preview-win32-arm64@7.0.0-dev.20260323.1", "", { "os": "win32", "cpu": "arm64" }, "sha512-3208Xoe+3Xblf6WLVTkIdyh6401zB2eXAhu1UaDpZY0rf8SMHCxKW3TSJDytpri5UivCotZ0CNC2wgJ1TlymUA=="], + + "@typescript/native-preview-win32-x64": ["@typescript/native-preview-win32-x64@7.0.0-dev.20260323.1", "", { "os": "win32", "cpu": "x64" }, "sha512-DAiRqrcs58eXwjFOtbklbIHq70IpW7uYz1Bx3kNAzqoWlA7R4mC29N6G0kGEZDalGmj7f0HVuckq9AzaC1r6oQ=="], + "@vitejs/plugin-react": ["@vitejs/plugin-react@4.7.0", "", { "dependencies": { "@babel/core": "7.29.0", "@babel/plugin-transform-react-jsx-self": "7.27.1", "@babel/plugin-transform-react-jsx-source": "7.27.1", "@rolldown/pluginutils": "1.0.0-beta.27", "@types/babel__core": "7.20.5", "react-refresh": "0.17.0" }, "peerDependencies": { "vite": "5.4.21" } }, "sha512-gUu9hwfWvvEDBBmgtAowQCojwZmJ5mcLn3aufeCsitijs3+f2NsrPtlAWIR6OPiqljl96GVCUbLe0HyqIpVaoA=="], "@vitest/coverage-v8": ["@vitest/coverage-v8@3.2.4", "", { "dependencies": { "@ampproject/remapping": "2.3.0", "@bcoe/v8-coverage": "1.0.2", "ast-v8-to-istanbul": "0.3.12", "debug": "4.4.3", "istanbul-lib-coverage": "3.2.2", "istanbul-lib-report": "3.0.1", "istanbul-lib-source-maps": "5.0.6", "istanbul-reports": "3.2.0", "magic-string": "0.30.21", "magicast": "0.3.5", "std-env": "3.10.0", "test-exclude": "7.0.2", "tinyrainbow": "2.0.0" }, "peerDependencies": { "vitest": "3.2.4" } }, "sha512-EyF9SXU6kS5Ku/U82E259WSnvg6c8KTjppUncuNdm5QHpe17mwREHnjDzozC8x9MZ0xfBUFSaLkRv4TMA75ALQ=="], diff --git a/docs/concepts/compositions.mdx b/docs/concepts/compositions.mdx index ea9872163..1304714e9 100644 --- a/docs/concepts/compositions.mdx +++ b/docs/concepts/compositions.mdx @@ -10,8 +10,7 @@ A composition is an HTML document that defines a video timeline. Every clip -- v Every composition needs a root element with `data-composition-id`: ```html index.html -
+
``` @@ -68,6 +67,7 @@ You can embed one composition inside another in two ways: loading from an extern
``` + Define a nested composition directly inside the parent. This is simpler for one-off compositions that do not need to be reused. @@ -93,6 +93,7 @@ You can embed one composition inside another in two ways: loading from an extern ``` Inline compositions do not use `