docs: switch to stackblitz (#614)

* switch to stackblitz * fix
TypeCellOS · Mar 5, 2024 · 890bd60 · 890bd60
1 parent c1747a2
commit 890bd60
Show file tree

Hide file tree

Showing 42 changed files with 74 additions and 67 deletions.
diff --git a/docs/components/example/ExampleBlock.tsx b/docs/components/example/ExampleBlock.tsx
@@ -1,20 +1,24 @@
 import dynamic from "next/dynamic";
-import { AiFillCodeSandboxCircle, AiFillGithub } from "react-icons/ai";
+import { AiFillGithub } from "react-icons/ai";
+import { SiStackblitz } from "react-icons/si";
 
 import { examples } from "./generated/exampleComponents.gen";
 import "./styles.css";
 
-const baseGitHubURL =
-  "https://github.com/TypeCellOS/BlockNote/tree/main/examples/";
-const baseCodeSandboxURL =
-  "https://githubbox.com/TypeCellOS/BlockNote/tree/main/examples/";
+const baseGitHubURL = "https://github.com/TypeCellOS/BlockNote/tree/main/";
+// const baseCodeSandboxURL =
+//   "https://githubbox.com/TypeCellOS/BlockNote/tree/main/";
+
+const baseStackBlitzURL =
+  "https://www.stackblitz.com/github/TypeCellOS/BlockNote/tree/main/";
 
 const ThemedExample = dynamic(() => import("./ThemedExample"), {
   ssr: false,
 });
 
 export function ExampleBlock(props: {
   name: keyof typeof examples;
+  path: string;
   children: any;
 }) {
   // const example = examplesFlattened.find((e) => e.slug === props.name);
@@ -25,24 +29,26 @@ export function ExampleBlock(props: {
   return (
     <div className="demo nx-bg-primary-700/5 dark:nx-bg-primary-300/10 mt-6 rounded-lg p-4">
       <div className={"flex flex-row gap-6 pb-4"}>
-        <button
+        <a
           className={
             "nx-select-none nx-text-gray-600 hover:nx-text-black dark:nx-text-gray-200 dark:hover:nx-text-white flex flex-row items-center gap-1"
           }
-          onClick={() => window.open(`${baseGitHubURL}${props.name}/`)}>
+          href={`${baseGitHubURL}${props.path}/`}
+          target="_blank">
           <AiFillGithub />
           <div className={"text-sm"}>GitHub</div>
-        </button>
-        <button
+        </a>
+        <a
           className={
             "nx-select-none nx-text-gray-600 hover:nx-text-black dark:nx-text-gray-200 dark:hover:nx-text-white flex flex-row items-center gap-1"
           }
-          onClick={() => window.open(`${baseCodeSandboxURL}${props.name}/`)}>
-          <AiFillCodeSandboxCircle />
-          <div className={"text-sm"}>CodeSandbox</div>
-        </button>
+          href={`${baseStackBlitzURL}${props.path}/`}
+          target="_blank">
+          <SiStackblitz />
+          <div className={"text-sm"}>StackBlitz</div>
+        </a>
       </div>
-      <div className={"h-96 overflow-auto rounded-lg"}>
+      <div className={"demo-contents h-96 overflow-auto rounded-lg"}>
         <ThemedExample name={props.name} />
       </div>
       {props.children}

diff --git a/docs/components/example/styles.css b/docs/components/example/styles.css
@@ -1,27 +1,28 @@
 :focus-visible {
-    box-shadow: unset !important;
+  box-shadow: unset !important;
 }
 
 .demo .nextra-code-block pre {
-    background-color: transparent !important;
-    margin: 0 !important;
-    padding: 0 !important;
+  background-color: transparent !important;
+  margin: 0 !important;
+  padding: 0 !important;
 }
 
 .demo .nextra-code-block code > span {
-    padding: 0 !important;
+  padding: 0 !important;
 }
 
-.demo .bn-container, .demo .bn-editor {
-    height: 100%;
+.demo .bn-container,
+.demo .bn-editor {
+  height: 100%;
 }
 
 .demo .bn-editor {
-    overflow: auto;
-    padding-block: 1rem;
+  overflow: auto;
+  padding-block: 1rem;
 }
 
-.demo a {
-    color: revert;
-    text-decoration: revert;
-}
+.demo-contents a {
+  color: revert;
+  text-decoration: revert;
+}
diff --git a/docs/pages/examples/index.mdx b/docs/pages/examples/index.mdx
@@ -4,6 +4,6 @@ import { ExampleList } from "../../components/example/ExampleList";
 
 Browse through the examples below to see how to use and customize BlockNote.
 
-Want to contribute? Copy the [basic example on CodeSandbox](https://codesandbox.io/s/github/TypeCellOS/BlockNote/tree/main/examples/basic/minimal) and submit a PR.
+Want to contribute? Copy the [basic example on StackBlitz](https://stackblitz.com/github/TypeCellOS/BlockNote/tree/main/examples/01-basic/01-minimal/) and submit a PR.
 
 <ExampleList />
diff --git a/examples/01-basic/01-minimal/tsconfig.json b/examples/01-basic/01-minimal/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/01-basic/02-block-objects/tsconfig.json b/examples/01-basic/02-block-objects/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/01-basic/03-all-blocks/tsconfig.json b/examples/01-basic/03-all-blocks/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/01-basic/04-selection-blocks/tsconfig.json b/examples/01-basic/04-selection-blocks/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/01-basic/05-block-manipulation/tsconfig.json b/examples/01-basic/05-block-manipulation/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/01-basic/06-file-uploading/tsconfig.json b/examples/01-basic/06-file-uploading/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/01-basic/07-saving-loading/tsconfig.json b/examples/01-basic/07-saving-loading/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/01-basic/testing/tsconfig.json b/examples/01-basic/testing/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/01-ui-elements-remove/tsconfig.json b/examples/02-ui-components/01-ui-elements-remove/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/02-formatting-toolbar-buttons/tsconfig.json b/examples/02-ui-components/02-formatting-toolbar-buttons/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/03-formatting-toolbar-block-type-items/tsconfig.json b/examples/02-ui-components/03-formatting-toolbar-block-type-items/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/04-side-menu-buttons/tsconfig.json b/examples/02-ui-components/04-side-menu-buttons/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/05-side-menu-drag-handle-items/tsconfig.json b/examples/02-ui-components/05-side-menu-drag-handle-items/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/06-suggestion-menus-slash-menu-items/tsconfig.json b/examples/02-ui-components/06-suggestion-menus-slash-menu-items/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/07-suggestion-menus-slash-menu-component/tsconfig.json b/examples/02-ui-components/07-suggestion-menus-slash-menu-component/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/08-custom-ui/tsconfig.json b/examples/02-ui-components/08-custom-ui/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/02-ui-components/hyperlink-toolbar-buttons/tsconfig.json b/examples/02-ui-components/hyperlink-toolbar-buttons/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/03-theming/01-theming-dom-attributes/tsconfig.json b/examples/03-theming/01-theming-dom-attributes/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/03-theming/02-changing-font/tsconfig.json b/examples/03-theming/02-changing-font/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/03-theming/03-theming-css/tsconfig.json b/examples/03-theming/03-theming-css/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/03-theming/04-theming-css-variables/tsconfig.json b/examples/03-theming/04-theming-css-variables/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/03-theming/05-theming-css-variables-code/tsconfig.json b/examples/03-theming/05-theming-css-variables-code/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/04-interoperability/01-converting-blocks-to-html/tsconfig.json b/examples/04-interoperability/01-converting-blocks-to-html/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/04-interoperability/02-converting-blocks-from-html/tsconfig.json b/examples/04-interoperability/02-converting-blocks-from-html/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/04-interoperability/03-converting-blocks-to-md/tsconfig.json b/examples/04-interoperability/03-converting-blocks-to-md/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/04-interoperability/04-converting-blocks-from-md/tsconfig.json b/examples/04-interoperability/04-converting-blocks-from-md/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/05-custom-schema/01-alert-block/tsconfig.json b/examples/05-custom-schema/01-alert-block/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/05-custom-schema/02-suggestion-menus-mentions/tsconfig.json b/examples/05-custom-schema/02-suggestion-menus-mentions/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/05-custom-schema/03-font-style/tsconfig.json b/examples/05-custom-schema/03-font-style/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/05-custom-schema/react-custom-blocks/tsconfig.json b/examples/05-custom-schema/react-custom-blocks/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },

diff --git a/examples/05-custom-schema/react-custom-inline-content/tsconfig.json b/examples/05-custom-schema/react-custom-inline-content/tsconfig.json
@@ -25,7 +25,7 @@
   "include": [
     "."
   ],
-  "references": [
+  "__ADD_FOR_LOCAL_DEV_references": [
     {
       "path": "../../../packages/core/"
     },