Skip to content

🎥 Make videos programmatically with React

Docs: Build Browser Studio without Docusaurus

Jonny Burgerbe947290c2b2
diff --git a/packages/docs/build-browser-studio-standalone.ts b/packages/docs/build-browser-studio-standalone.ts
new file mode 100644
index 0000000000..061895cba9
--- /dev/null
+++ b/packages/docs/build-browser-studio-standalone.ts
@@ -0,0 +1,131 @@
+import {copyFileSync, cpSync, mkdirSync} from 'node:fs';
+import path from 'node:path';
+import {build} from 'bun';
+import {getBrowserStudioDependencyVersionsForBuild} from '../browser-studio/src/dev/get-dependency-versions-for-build';
+import {getBrowserStudioReactRefreshFilesForBuild} from '../browser-studio/src/dev/get-react-refresh-files-for-build';
+import {getBrowserStudioSetupEnvironmentForBuild} from '../browser-studio/src/dev/get-setup-environment-for-build';
+import {getBrowserStudioWorkspacePackageExportsForBuild} from '../browser-studio/src/dev/get-workspace-package-exports-for-build';
+import {getBrowserStudioWorkspaceCommit} from './get-browser-studio-workspace-commit';
+
+const commit = getBrowserStudioWorkspaceCommit();
+const browserStudioDir = path.join(import.meta.dir, '..', 'browser-studio');
+const outputDir = path.join(
+ import.meta.dir,
+ 'build',
+ 'assets',
+ 'experimental-new',
+ commit,
+);
+const publicAssetPath = `/assets/experimental-new/${commit}`;
+const dependencyVersions = getBrowserStudioDependencyVersionsForBuild();
+const reactRefreshFiles = getBrowserStudioReactRefreshFilesForBuild();
+const setupEnvironment = getBrowserStudioSetupEnvironmentForBuild();
+const workspacePackageExports =
+ getBrowserStudioWorkspacePackageExportsForBuild();
+
+mkdirSync(outputDir, {recursive: true});
+
+const workspaceRelativePath = path.join(
+ '__remotion_browser_studio_workspace__',
+ 'commits',
+ commit,
+);
+cpSync(
+ path.join(import.meta.dir, 'static', workspaceRelativePath),
+ path.join(import.meta.dir, 'build', workspaceRelativePath),
+ {recursive: true},
+);
+
+const faviconOutputDir = path.join(import.meta.dir, 'build', 'img');
+mkdirSync(faviconOutputDir, {recursive: true});
+copyFileSync(
+ path.join(import.meta.dir, 'static', 'img', 'favicon.png'),
+ path.join(faviconOutputDir, 'favicon.png'),
+);
+
+const output = await build({
+ define: {
+ __BROWSER_STUDIO_DEPENDENCY_VERSIONS__: JSON.stringify(dependencyVersions),
+ __BROWSER_STUDIO_REACT_REFRESH_FILES__: JSON.stringify(reactRefreshFiles),
+ __BROWSER_STUDIO_SETUP_ENVIRONMENT__: JSON.stringify(setupEnvironment),
+ __BROWSER_STUDIO_WORKSPACE_COMMIT__: JSON.stringify(commit),
+ __BROWSER_STUDIO_WORKSPACE_PACKAGE_EXPORTS__: JSON.stringify(
+ workspacePackageExports,
+ ),
+ 'process.env.NODE_ENV': JSON.stringify('production'),
+ },
+ entrypoints: [
+ path.join(import.meta.dir, 'standalone', 'experimental-new', 'index.tsx'),
+ path.join(browserStudioDir, 'src', 'browser-studio-worker.ts'),
+ ],
+ format: 'esm',
+ minify: true,
+ naming: '[name].mjs',
+ outdir: outputDir,
+ target: 'browser',
+});
+
+if (!output.success) {
+ throw new Error(output.logs.join('\n'));
+}
+
+await Bun.write(
+ path.join(outputDir, 'browser-studio-vendor-entry.mjs'),
+ Bun.file(
+ path.join(
+ browserStudioDir,
+ 'dist',
+ 'esm',
+ 'browser-studio-vendor-entry.mjs',
+ ),
+ ),
+);
+
+const rspackBrowserDist = path.join(
+ browserStudioDir,
+ 'node_modules',
+ '@rspack',
+ 'browser',
+ 'dist',
+);
+for (const asset of ['rspack.wasm32-wasi.wasm', 'wasi-worker-browser.mjs']) {
+ await Bun.write(
+ path.join(outputDir, asset),
+ Bun.file(path.join(rspackBrowserDist, asset)),
+ );
+}
+
+const html = `<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>New Remotion Project</title>
+ <link rel="icon" href="/img/favicon.png" />
+ <style>
+ html,
+ body,
+ #root {
+ background: #111111;
+ height: 100%;
+ margin: 0;
+ overflow: hidden;
+ width: 100%;
+ }
+ </style>
+ </head>
+ <body>
+ <div id="root"></div>
+ <script type="module" src="${publicAssetPath}/index.mjs"></script>
+ </body>
+</html>
+`;
+
+await Bun.write(
+ path.join(import.meta.dir, 'build', 'experimental_new', 'index.html'),
+ html,
+);
+
+process.stdout.write(
+ `Built standalone Browser Studio at /experimental_new with ${output.outputs.length + 4} assets.\n`,
+);
diff --git a/packages/docs/build-docs.ts b/packages/docs/build-docs.ts
index a1d02ea3d5..b773afe034 100644
--- a/packages/docs/build-docs.ts
+++ b/packages/docs/build-docs.ts
@@ -135,6 +135,9 @@ await run(
docusaurusBuild.args,
docusaurusEnv,
);
+await run('build standalone Browser Studio', 'bun', [
+ 'build-browser-studio-standalone.ts',
+]);
await run('copy convert assets', 'bun', ['copy-convert.ts']);
await run('generate asset manifest', 'bun', ['generate-asset-manifest.ts']);
await run('count generated pages', 'bun', ['count-pages.ts']);
diff --git a/packages/docs/docusaurus.config.ts b/packages/docs/docusaurus.config.ts
index 4edf17c798..5888728123 100644
--- a/packages/docs/docusaurus.config.ts
+++ b/packages/docs/docusaurus.config.ts
@@ -1,5 +1,4 @@
import type {Config} from '@docusaurus/types';
-import {getBrowserStudioWorkspaceCommit} from './get-browser-studio-workspace-commit';
import elementSourceDependencies from './plugins/element-source-dependencies.js';
import remarkElementSource from './plugins/remark-element-source.js';
import remarkExportRaw from './plugins/remark-export-raw.js';
@@ -28,9 +27,6 @@ const showGitLastUpdate =
process.env.REMOTION_DOCS_DISABLE_GIT_LAST_UPDATE !== '1';
const config: Config = {
- customFields: {
- browserStudioWorkspaceCommit: getBrowserStudioWorkspaceCommit(),
- },
title: 'Remotion | Make videos programmatically',
tagline: 'Make videos programmatically',
url: 'https://www.remotion.dev',
diff --git a/packages/docs/eslint.config.mjs b/packages/docs/eslint.config.mjs
index 2b81aba678..941f239185 100644
--- a/packages/docs/eslint.config.mjs
+++ b/packages/docs/eslint.config.mjs
@@ -4,7 +4,13 @@ const config = remotionFlatConfig({react: true});
export default {
...config,
- files: [...config.files, 'components/**/*.ts', 'components/**/*.tsx'],
+ files: [
+ ...config.files,
+ 'components/**/*.ts',
+ 'components/**/*.tsx',
+ 'standalone/**/*.ts',
+ 'standalone/**/*.tsx',
+ ],
rules: {
...config.rules,
'no-console': 'off',
diff --git a/packages/docs/package.json b/packages/docs/package.json
index 0e3d863225..f6c3771919 100644
--- a/packages/docs/package.json
+++ b/packages/docs/package.json
@@ -6,17 +6,18 @@
"private": true,
"version": "4.0.516",
"scripts": {
- "formatting": "oxfmt src --check",
- "format": "oxfmt src",
+ "formatting": "oxfmt src standalone --check",
+ "format": "oxfmt src standalone",
"docusaurus": "docusaurus",
"start": "bun copy-raw-docs.ts && bun fetch-prompt-submissions.ts && bun update-prompt.ts && cd .. && bun run build && cd docs && bun prepare-browser-studio-workspace.ts && if [ \"$REMOTION_DOCS_ENABLE_TWOSLASH\" = \"1\" ]; then echo \"🧪 Twoslash is enabled in development.\"; else echo \"⚡ Twoslash is disabled in development for faster startup.\"; echo \" Enable it with: REMOTION_DOCS_ENABLE_TWOSLASH=1 bun run start\"; fi && REMOTION_DOCS_DISABLE_TWOSLASH=1 docusaurus start --host 0.0.0.0",
"build-docs": "bun build-docs.ts",
+ "build-browser-studio": "bun prepare-browser-studio-workspace.ts && bun build-browser-studio-standalone.ts",
"prewarm-twoslash": "bun prewarm-twoslash.ts",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"serve": "docusaurus serve",
"clear": "docusaurus clear",
- "lint": "eslint src components",
+ "lint": "eslint src components standalone",
"test": "bun test src",
"remotion": "remotion studio src/remotion/entry.ts --no-open",
"render-cards": "bun run render-cards.ts",
diff --git a/packages/docs/src/theme/Layout/index.tsx b/packages/docs/src/theme/Layout/index.tsx
index 8c6d3c4a71..4a53fec4de 100644
--- a/packages/docs/src/theme/Layout/index.tsx
+++ b/packages/docs/src/theme/Layout/index.tsx
@@ -1,4 +1,4 @@
-import {useHistory, useLocation} from '@docusaurus/router';
+import {useHistory} from '@docusaurus/router';
import type {WrapperProps} from '@docusaurus/types';
import '@remotion/promo-pages/dist/tailwind.css';
import Layout from '@theme-original/Layout';
@@ -8,9 +8,6 @@ import React, {useEffect, type ReactNode} from 'react';
type Props = WrapperProps<typeof LayoutType>;
-const isStandaloneRoute = (pathname: string) =>
- pathname === '/experimental_new' || pathname.startsWith('/experimental_new/');
-
const CRAWLCHAT_SCRIPT_ID = 'crawlchat-script';
// The script must be injected imperatively rather than rendered as JSX:
@@ -45,12 +42,6 @@ const LayoutWithCrawlChat = (props: Props): ReactNode => {
};
const LayoutWrapper = (props: Props): ReactNode => {
- const {pathname} = useLocation();
-
- if (isStandaloneRoute(pathname)) {
- return props.children;
- }
-
return <LayoutWithCrawlChat {...props} />;
};
diff --git a/packages/docs/src/pages/experimental_new/index.tsx b/packages/docs/standalone/experimental-new/index.tsx
similarity index 81%
rename from packages/docs/src/pages/experimental_new/index.tsx
rename to packages/docs/standalone/experimental-new/index.tsx
index 142c701c19..7e3ef66c36 100644
--- a/packages/docs/src/pages/experimental_new/index.tsx
+++ b/packages/docs/standalone/experimental-new/index.tsx
@@ -1,6 +1,3 @@
-import BrowserOnly from '@docusaurus/BrowserOnly';
-import Head from '@docusaurus/Head';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import {
BrowserStudio,
createBlankTemplateProject,
@@ -10,9 +7,13 @@ import {
} from '@remotion/browser-studio';
import {StudioProtocolInternals} from '@remotion/studio-protocol';
import React, {useEffect, useState} from 'react';
+import {createRoot} from 'react-dom/client';
+
+declare const __BROWSER_STUDIO_WORKSPACE_COMMIT__: string;
const page: React.CSSProperties = {
backgroundColor: '#111111',
+ color: '#ffffff',
height: '100dvh',
inset: 0,
overflow: 'hidden',
@@ -56,24 +57,6 @@ const progressBar: React.CSSProperties = {
width: '100%',
};
-const standaloneCss = `
- html,
- body,
- #__docusaurus {
- background: #111111;
- height: 100%;
- margin: 0;
- overflow: hidden;
- width: 100%;
- }
-
- .navbar,
- .footer,
- #crawlchat-script {
- display: none !important;
- }
-`;
-
type InitialElementState =
| {type: 'none'}
| {type: 'invalid'}
@@ -131,9 +114,7 @@ const getInitialElementState = (): InitialElementState => {
return {type: 'payload', payload: {payload, sourceOrigin}};
};
-const BrowserStudioContent: React.FC<{
- readonly browserStudioWorkspaceCommit: string;
-}> = ({browserStudioWorkspaceCommit}) => {
+const BrowserStudioContent: React.FC = () => {
const [initialElementState] = useState(getInitialElementState);
const [projectState, setProjectState] = useState(getInitialProjectState);
const loadingRepoUrl =
@@ -260,7 +241,6 @@ const BrowserStudioContent: React.FC<{
backgroundColor: '#0b84f3',
border: 0,
borderRadius: 4,
- color: '#ffffff',
cursor: 'pointer',
fontSize: 14,
marginTop: 20,
@@ -279,7 +259,6 @@ const BrowserStudioContent: React.FC<{
return (
<BrowserStudio
- iframeSrc="/experimental_new/frame.html"
initialElement={
initialElementState.type === 'payload'
? initialElementState.payload
@@ -289,41 +268,23 @@ const BrowserStudioContent: React.FC<{
readOnly={false}
remotionPackageSource={{
baseUrl: new URL(
- `/__remotion_browser_studio_workspace__/commits/${browserStudioWorkspaceCommit}/`,
+ `/__remotion_browser_studio_workspace__/commits/${__BROWSER_STUDIO_WORKSPACE_COMMIT__}/`,
window.location.href,
).href,
- commit: browserStudioWorkspaceCommit,
+ commit: __BROWSER_STUDIO_WORKSPACE_COMMIT__,
type: 'workspace',
}}
/>
);
};
-const NewRemotionProject = () => {
- const {siteConfig} = useDocusaurusContext();
- const browserStudioWorkspaceCommit =
- siteConfig.customFields?.browserStudioWorkspaceCommit;
- if (typeof browserStudioWorkspaceCommit !== 'string') {
- throw new Error('Browser Studio workspace commit is not configured');
- }
-
- return (
- <>
- <Head>
- <title>New Remotion Project</title>
- <style>{standaloneCss}</style>
- </Head>
- <div style={page}>
- <BrowserOnly fallback={<div style={fallback}>Loading...</div>}>
- {() => (
- <BrowserStudioContent
- browserStudioWorkspaceCommit={browserStudioWorkspaceCommit}
- />
- )}
- </BrowserOnly>
- </div>
- </>
- );
-};
+const root = document.getElementById('root');
+if (!root) {
+ throw new Error('Could not find root element');
+}
-export default NewRemotionProject;
+createRoot(root).render(
+ <div style={page}>
+ <BrowserStudioContent />
+ </div>,
+);
diff --git a/packages/docs/static/experimental_new/frame.html b/packages/docs/static/experimental_new/frame.html
deleted file mode 100644
index d95c602da7..0000000000
--- a/packages/docs/static/experimental_new/frame.html
+++ /dev/null
@@ -1,19 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="UTF-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <title>Remotion Studio Frame</title>
- <style>
- html,
- body {
- background: #111111;
- height: 100%;
- margin: 0;
- overflow: hidden;
- width: 100%;
- }
- </style>
- </head>
- <body></body>
-</html>
diff --git a/packages/docs/tsconfig.json b/packages/docs/tsconfig.json
index 90bd2bc223..bd52927745 100644
--- a/packages/docs/tsconfig.json
+++ b/packages/docs/tsconfig.json
@@ -56,6 +56,7 @@
{"path": "../cli"}
],
"exclude": [
+ "build-browser-studio-standalone.ts",
"copy-convert.ts",
"prepare-browser-studio-workspace.ts",
"render-cards.ts",