docs: Use shared module to build website (#2230)

visgl · Sep 18, 2024 · ece2af5 · ece2af5
1 parent 9a82784
commit ece2af5
Show file tree

Hide file tree

Showing 84 changed files with 376 additions and 4,190 deletions.
diff --git a/docs/developer-guide/installing.md b/docs/developer-guide/installing.md
@@ -11,12 +11,10 @@ However, the `@luma.gl/core` module cannot be used on its own: it relies on bein
 that implements the API. luma.gl provides adapters (implementations of the abstract API)
 through the `@luma.gl/webgl` and `@luma.gl/webgpu` modules.
 
-The `@luma.gl/core` module is not usable on its own. A device adapter module must
-be imported.
+The `@luma.gl/core` module is not usable on its own. A device adapter module must be imported.
 
 ```bash
 yarn add @luma.gl/core
-yarn add @luma.gl/webgl
 yarn add @luma.gl/webgpu
 ```
 

diff --git a/docs/sidebar.json → docs/table-of-contents.json b/docs/sidebar.json → docs/table-of-contents.json
diff --git a/docs/tutorials/hello-cube.mdx b/docs/tutorials/hello-cube.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {HelloCubeExample} from '@site';
+import {HelloCubeExample} from '@site/src/examples';
 
 # Hello Cube
 

diff --git a/docs/tutorials/hello-instancing.mdx b/docs/tutorials/hello-instancing.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {HelloInstancingExample} from '@site';
+import {HelloInstancingExample} from '@site/src/examples';
 
 # Hello Instancing
 

diff --git a/docs/tutorials/hello-triangle.mdx b/docs/tutorials/hello-triangle.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {HelloTriangleExample} from '@site';
+import {HelloTriangleExample} from '@site/src/examples';
 
 # Hello Triangle
 

diff --git a/docs/tutorials/lighting.mdx b/docs/tutorials/lighting.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {LightingExample} from '@site';
+import {LightingExample} from '@site/src/examples';
 
 # Lighting
 

diff --git a/docs/tutorials/shader-hooks.mdx b/docs/tutorials/shader-hooks.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {ShaderHooksExample} from '@site';
+import {ShaderHooksExample} from '@site/src/examples';
 
 # Shader Hooks
 

diff --git a/docs/tutorials/shader-modules.mdx b/docs/tutorials/shader-modules.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {ShaderModulesExample} from '@site';
+import {ShaderModulesExample} from '@site/src/examples';
 
 # Shader Modules
 

diff --git a/docs/tutorials/transform-feedback.mdx b/docs/tutorials/transform-feedback.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {TransformFeedbackExample} from '@site';
+import {TransformFeedbackExample} from '@site/src/examples';
 
 # Transform Feedback
 

diff --git a/docs/tutorials/transform.mdx b/docs/tutorials/transform.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {TransformExample} from '@site';
+import {TransformExample} from '@site/src/examples';
 
 # Transform
 

diff --git a/website/babel.config.js b/website/babel.config.js
@@ -1,79 +1,4 @@
-// Copied from '@docusaurus/core/lib/babel/preset' template
-const ESM_TARGETS = ['>0.2% and supports async-functions', 'maintained node versions', 'not dead'];
-
-"use strict";
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-function getTransformOptions(isServer) {
-    const absoluteRuntimePath = path_1.default.dirname(require.resolve(`@babel/runtime/package.json`));
-    return {
-        // All optional newlines and whitespace will be omitted when generating code
-        // in compact mode
-        compact: true,
-        presets: [
-            isServer
-                ? [
-                    require.resolve('@babel/preset-env'),
-                    {
-                        targets: {
-                            node: 16,
-                        },
-                    },
-                ]
-                : [
-                    require.resolve('@babel/preset-env'),
-                    {
-                        targets: ESM_TARGETS,
-                        useBuiltIns: 'entry',
-                        loose: true,
-                        corejs: '3',
-                        // Do not transform modules to CJS
-                        modules: false,
-                        // Exclude transforms that make all code slower
-                        exclude: ['transform-typeof-symbol', 'transform-regenerator', 'transform-async-to-generator'],
-                    },
-                ],
-            require.resolve('@babel/preset-react'),
-            require.resolve('@babel/preset-typescript'),
-        ],
-        plugins: [
-            // // Polyfills the runtime needed for async/await, generators, and friends
-            // // https://babeljs.io/docs/en/babel-plugin-transform-runtime
-            // [
-            //     require.resolve('@babel/plugin-transform-runtime'),
-            //     {
-            //         corejs: false,
-            //         helpers: false,
-            //         // By default, it assumes @babel/[email protected]. Since we use >7.0.0,
-            //         // better to explicitly specify the version so that it can reuse the
-            //         // helper better. See https://github.com/babel/babel/issues/10261
-            //         // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
-            //         version: require('@babel/runtime/package.json')
-            //             .version,
-            //         regenerator: false,
-            //         useESModules: true,
-            //         // Undocumented option that lets us encapsulate our runtime, ensuring
-            //         // the correct version is used
-            //         // https://github.com/babel/babel/blob/090c364a90fe73d36a30707fc612ce037bdbbb24/packages/babel-plugin-transform-runtime/src/index.js#L35-L42
-            //         absoluteRuntime: absoluteRuntimePath,
-            //     },
-            // ],
-            // Adds syntax support for import()
-            isServer
-                ? require.resolve('babel-plugin-dynamic-import-node')
-                : require.resolve('@babel/plugin-syntax-dynamic-import'),
-        ],
-    };
-}
-function babelPresets(api) {
-    const callerName = api.caller((caller) => caller?.name);
-    return getTransformOptions(callerName === 'server');
-}
-exports.default = babelPresets;
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+  plugins: ["styled-components"]
+};
diff --git a/website/content/examples/api/animation.mdx b/website/content/examples/api/animation.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {AnimationExample} from '@site';
+import {AnimationExample} from '@site/src/examples';
 
 # Animation
 

diff --git a/website/content/examples/api/cubemap.mdx b/website/content/examples/api/cubemap.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {CubemapExample} from '@site';
+import {CubemapExample} from '@site/src/examples';
 
 # Cubemap
 

diff --git a/website/content/examples/api/texture-3d.mdx b/website/content/examples/api/texture-3d.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {Texture3DExample} from '@site';
+import {Texture3DExample} from '@site/src/examples';
 
 # Texture 3D
 

diff --git a/website/content/examples/index.mdx b/website/content/examples/index.mdx
@@ -1,6 +1,6 @@
 # Examples
 
-import {ExamplesIndex} from '@site/src/examples/components';
+import {ExamplesIndex} from '@vis.gl/docusaurus-website/components';
 
 <ExamplesIndex
   getThumbnail={item => {

diff --git a/website/content/examples/showcase/instancing.mdx b/website/content/examples/showcase/instancing.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {InstancingExample} from '@site';
+import {InstancingExample} from '@site/src/examples';
 
 # Instancing
 

diff --git a/website/content/examples/showcase/persistence.mdx b/website/content/examples/showcase/persistence.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {PersistenceExample} from '@site';
+import {PersistenceExample} from '@site/src/examples';
 
 # Persistence
 

diff --git a/website/content/examples/showcase/postprocessing.mdx b/website/content/examples/showcase/postprocessing.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {PostprocessingExample} from '@site';
+import {PostprocessingExample} from '@site/src/examples';
 
 # Postprocessing
 

diff --git a/website/content/examples/table-of-contents.json b/website/content/examples/table-of-contents.json
@@ -0,0 +1,42 @@
+[
+  {
+    "type": "doc",
+    "label": "Overview",
+    "id": "index"
+  },
+  {
+    "type": "category",
+    "label": "Showcase",
+    "items": [
+      "showcase/instancing",
+      "showcase/persistence",
+      "showcase/postprocessing"
+    ]
+  },
+  {
+    "type": "category",
+    "label": "API",
+    "items": [
+      "api/animation",
+      "api/cubemap",
+      "api/texture-3d"
+    ]
+  },
+  {
+    "type": "category",
+    "label": "Tutorials",
+    "items": [
+      "tutorials/hello-triangle",
+      "tutorials/hello-cube",
+      "tutorials/lighting",
+      "tutorials/hello-gltf",
+      "tutorials/two-cubes",
+      "tutorials/instanced-cubes",
+      "tutorials/hello-instancing",
+      "tutorials/shader-modules",
+      "tutorials/shader-hooks",
+      "tutorials/transform-feedback",
+      "tutorials/transform"
+    ]
+  }
+]
diff --git a/website/content/examples/tutorials/hello-cube.mdx b/website/content/examples/tutorials/hello-cube.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {HelloCubeExample} from '@site';
+import {HelloCubeExample} from '@site/src/examples';
 
 # Hello Cube
 

diff --git a/website/content/examples/tutorials/hello-gltf.mdx b/website/content/examples/tutorials/hello-gltf.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {HelloGLTFExample} from '@site';
+import {HelloGLTFExample} from '@site/src/examples';
 
 # Hello glTF
 

diff --git a/website/content/examples/tutorials/hello-instancing.mdx b/website/content/examples/tutorials/hello-instancing.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {HelloInstancingExample} from '@site';
+import {HelloInstancingExample} from '@site/src/examples';
 
 # Hello Instancing
 

diff --git a/website/content/examples/tutorials/hello-triangle-geometry.mdx b/website/content/examples/tutorials/hello-triangle-geometry.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {HelloTriangleGeometryExample} from '@site';
+import {HelloTriangleGeometryExample} from '@site/src/examples';
 
 # Triangle
 

diff --git a/website/content/examples/tutorials/hello-triangle.mdx b/website/content/examples/tutorials/hello-triangle.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {HelloTriangleExample} from '@site';
+import {HelloTriangleExample} from '@site/src/examples';
 
 # Hello Triangle
 

diff --git a/website/content/examples/tutorials/instanced-cubes.mdx b/website/content/examples/tutorials/instanced-cubes.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {InstancedCubesExample} from '@site';
+import {InstancedCubesExample} from '@site/src/examples';
 
 # Instanced Cubes
 

diff --git a/website/content/examples/tutorials/lighting.mdx b/website/content/examples/tutorials/lighting.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {LightingExample} from '@site';
+import {LightingExample} from '@site/src/examples';
 
 # Hello Lighting
 

diff --git a/website/content/examples/tutorials/shader-hooks.mdx b/website/content/examples/tutorials/shader-hooks.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {ShaderHooksExample} from '@site';
+import {ShaderHooksExample} from '@site/src/examples';
 
 # Shader Hooks
 

diff --git a/website/content/examples/tutorials/shader-modules.mdx b/website/content/examples/tutorials/shader-modules.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {ShaderModulesExample} from '@site';
+import {ShaderModulesExample} from '@site/src/examples';
 
 # Shader Modules
 

diff --git a/website/content/examples/tutorials/transform-feedback.mdx b/website/content/examples/tutorials/transform-feedback.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {TransformFeedbackExample} from '@site';
+import {TransformFeedbackExample} from '@site/src/examples';
 
 # Transform Feedback
 

diff --git a/website/content/examples/tutorials/transform.mdx b/website/content/examples/tutorials/transform.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {TransformExample} from '@site';
+import {TransformExample} from '@site/src/examples';
 
 # Transform
 

diff --git a/website/content/examples/tutorials/two-cubes.mdx b/website/content/examples/tutorials/two-cubes.mdx
@@ -1,5 +1,5 @@
 import {DeviceTabs} from '@site/src/react-luma';
-import {TwoCubesExample} from '@site';
+import {TwoCubesExample} from '@site/src/examples';
 
 # Two Cubes
 

diff --git a/website/content/showcase.json b/website/content/showcase.json
diff --git a/website/content/sidebars.js b/website/content/sidebars.js