Upgrades and improvements (#398)

Co-authored-by: ekwuno <[email protected]> Co-authored-by: Dimitri <[email protected]> Co-authored-by: Micha de Vries <[email protected]>
surrealdb · Mar 12, 2024 · 2365a35 · 2365a35
1 parent c93a255
commit 2365a35
Show file tree

Hide file tree

Showing 726 changed files with 5,207 additions and 106,274 deletions.
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-v16.14.2
+v20.11.1
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -1,88 +1,42 @@
-const fs = require('fs');
 const isProd = process.env.IS_PROD_BUILD == "true";
 const config = {
   title: 'SurrealDB Docs',
   tagline: 'SurrealDB Docs',
-  favicon: 'img/favicon.ico',
-  // Set the production url of your site here
+  favicon: '/img/favicon.ico',
   url: 'https://surrealdb.com',
-  // Set the /<baseUrl>/ pathname under which your site is served
   baseUrl: '/docs/',
-  // TODO We need to fix these issues, just not doing it now :)
-  onBrokenLinks: 'warn',
-  onBrokenMarkdownLinks: 'warn',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'throw',
   i18n: {
     defaultLocale: 'en',
     locales: ['en'],
   },
-  plugins: [
-    'docusaurus-plugin-sass',
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'rust',
-        path: "./sdks/rust",
-        routeBasePath: "./sdks/rust",
-        include: ["**/*.md"],
-        sidebarPath: require.resolve('./sdks/rust/sidebarsRust.js'),
-      },
-    ],
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'golang',
-        path: "./sdks/golang",
-        routeBasePath: "./sdks/golang",
-        include: ["**/*.md"],
-        sidebarPath: require.resolve('./sdks/golang/sidebarsGolang.js'),
-      },
-    ],
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'node',
-        path: "./sdks/node",
-        routeBasePath: "./sdks/node",
-        include: ["**/*.md"],
-        sidebarPath: require.resolve('./sdks/node/sidebarsNode.js'),
-      },
-    ],
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'python',
-        path: "./sdks/python",
-        routeBasePath: "./sdks/node",
-        include: ["**/*.md"],
-        sidebarPath: require.resolve('./sdks/python/sidebarsPython.js'),
-      },
-    ],
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'deno',
-        path: "./sdks/deno",
-        routeBasePath: "./sdks/deno",
-        include: ["**/*.md"],
-        sidebarPath: require.resolve('./sdks/deno/sidebarsDeno.js'),
-      },
-    ],
+  presets: [
     [
-      '@docusaurus/plugin-content-docs',
+      '@docusaurus/preset-classic',
       {
-        id: 'java',
-        path: "./sdks/java",
-        routeBasePath: "./sdks/java",
-        include: ["**/*.md"],
-        sidebarPath: require.resolve('./sdks/java/sidebarsJava.js'),
+        docs: {
+          sidebarCollapsed: true,
+          sidebarCollapsible: true,
+          includeCurrentVersion: false,
+          routeBasePath: '/surrealdb',
+          lastVersion: '1.x',
+          versions: {
+            "1.x": {
+              label: '1.x',
+              path: '',
+            },
+          },
+          editUrl: 'https://github.com/surrealdb/docs.surrealdb.com/edit/main/',
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.scss'),
+        },
       },
     ],
-    // [
-    //   './plugins/shiki',
-    //   {
-    //     themes: ["min-light", "nord"],
-    //   },
-    // ],
+  ],
+  plugins: [
+    'docusaurus-plugin-sass',
     ...(isProd ? [
       [
         'docusaurus-plugin-sentry',
@@ -120,70 +74,6 @@ const config = {
       ],
     ] : []),
   ],
-  presets: [
-    [
-      'classic',
-      ({
-        docs: {
-          routeBasePath: '/surrealdb',
-          lastVersion: '1.2.x',
-          versions: {
-            "1.1.x": {
-              label: '1.1.x',
-              path: '1.1.x',
-            },
-            nightly: {
-              label: 'Nightly',
-              path: 'nightly',
-            },
-            '1.2.x': {
-              label: '1.2.x',
-              path: '',
-            },
-            '1.0.x': {
-              label: '1.0.x',
-              path: '1.0.x',
-            },
-          },
-          includeCurrentVersion: false,
-          editUrl:
-            'https://github.com/surrealdb/docs.surrealdb.com/edit/main/',
-        },
-        theme: {
-          customCss: require.resolve('./src/css/custom.scss'),
-        },
-      }),
-    ],
-    // [
-    //   './src/plugins/shiki',
-    //   {
-    //     theme: JSON.parse(fs.readFileSync('./src/grammars/surrealql-theme.json', 'utf-8')),
-    //     langs: [
-    //       {
-    //         id: 'surql',
-    //         scopeName: 'source.surrealql',
-    //         grammar: JSON.parse(fs.readFileSync('./src/grammars/surrealql.tmLanguage.json', 'utf-8')),
-    //         aliases: ['surrealql']
-    //       },
-    //       'javascript',
-    //       'typescript',
-    //       'bash',
-    //       'shell',
-    //       'yaml',
-    //       'markdown',
-    //       'python',
-    //       'json',
-    //       'rust',
-    //       'jsx',
-    //       'sql',
-    //       'java',
-    //       'go',
-    //       'jsx',
-    //       'csharp'
-    //     ],
-    //   },
-    // ],
-  ],
   themeConfig:
     ({
       colorMode: {
@@ -192,13 +82,13 @@ const config = {
         respectPrefersColorScheme: false,
       },
       // Replace with your project's social card
-      image: 'img/docusaurus-social-card.jpg',
+      image: '/img/docusaurus-social-card.jpg',
       navbar: {
         title: '',
         logo: {
           alt: 'SurrealDB Logo',
-          src: 'img/logo-surrealdb-dark.svg',
-          srcDark: 'img/logo-surrealdb.svg',
+          src: '/img/logo-surrealdb-dark.svg',
+          srcDark: '/img/logo-surrealdb.svg',
         },
         items: [
           {

diff --git a/package.json b/package.json
@@ -16,39 +16,38 @@
   },
   "dependencies": {
     "@babel/plugin-transform-react-jsx": "^7.22.15",
-    "@docusaurus/core": "^2.4.3",
-    "@docusaurus/plugin-content-docs": "^2.4.3",
-    "@docusaurus/plugin-google-gtag": "^2.4.3",
-    "@docusaurus/preset-classic": "^2.4.3",
-    "@docusaurus/theme-common": "^2.4.3",
+    "@docusaurus/core": "^3.1.1",
+    "@docusaurus/plugin-content-docs": "^3.1.1",
+    "@docusaurus/plugin-google-gtag": "^3.1.1",
+    "@docusaurus/preset-classic": "^3.1.1",
+    "@docusaurus/theme-common": "^3.1.1",
     "@fortawesome/fontawesome-svg-core": "^6.5.1",
     "@fortawesome/free-brands-svg-icons": "^6.5.1",
     "@fortawesome/free-regular-svg-icons": "^6.5.1",
     "@fortawesome/free-solid-svg-icons": "^6.5.1",
     "@fortawesome/react-fontawesome": "^0.2.0",
     "@giscus/react": "^2.4.0",
-    "@mdx-js/react": "^1.6.22",
+    "@mdx-js/react": "^3.0.1",
     "clsx": "^1.2.1",
     "copy-text-to-clipboard": "^3.2.0",
     "docusaurus-plugin-sass": "^0.2.5",
-    "docusaurus-plugin-sentry": "1.1.0",
+    "docusaurus-plugin-sentry": "2.0.0",
     "lodash": "^4.17.21",
-    "prism-react-renderer": "^1.3.5",
+    "prism-react-renderer": "^2.3.1",
     "prismjs": "^1.29.0",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "remark-shiki-twoslash": "^3.1.3",
-    "sass": "^1.68.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "sass": "^1.71.0",
     "styled-components": "^6.0.8"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.1",
-    "@docusaurus/types": "^2.4.3",
-    "@tsconfig/docusaurus": "^1.0.5",
-    "@types/react": "^18.2.21",
-    "@types/react-helmet": "^6.1.6",
+    "@docusaurus/module-type-aliases": "3.1.1",
+    "@docusaurus/tsconfig": "^3.1.1",
+    "@docusaurus/types": "^3.1.1",
+    "@types/react": "^18.2.64",
+    "@types/react-helmet": "^6.1.11",
     "@types/react-router-dom": "^5.3.3",
-    "typescript": "^4.7.4"
+    "typescript": "^5.4.2"
   },
   "browserslist": {
     "production": [
@@ -63,6 +62,6 @@
     ]
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=18.0"
   }
-}
+}