Merge master

docs/docs/getting_started.mdx

@@ -55,7 +55,7 @@ https://api-test.build5.com
 
 Let's do a simple GET Request to get the member's object of `@adam_unchained`:
 
-```
+```tsx
 import { Build5, https } from '@build-5/sdk';
 import { Dataset } from '@build-5/interfaces';
 

docs/docusaurus.config.js

@@ -1,8 +1,11 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
+import codeImport from 'remark-code-import';
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const path = require('path');
+const {themes} = require('prism-react-renderer');
+const lightTheme = themes.github;
+const darkTheme = themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -95,7 +98,7 @@ const config = {
           sidebarPath: require.resolve('./sidebars.js'),
           remarkPlugins: [
             [require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}],
-            require('remark-code-import'),
+            [codeImport, {rootDir: path.resolve('../.')}],
           ],
         },
         blog: false,
@@ -178,9 +181,9 @@ const config = {
         copyright: `Copyright © ${new Date().getFullYear()} BUILD.5. All Rights Reserved.`,
       },
       prism: {
-        theme: lightCodeTheme,
-        darkTheme: darkCodeTheme,
-        dditionalLanguages: ['ts'],
+        theme: lightTheme,
+        darkTheme: darkTheme,
+        additionalLanguages: ['bash'],
       },
     }),
 };

docs/package.json

@@ -16,28 +16,27 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "2.4.1",
-    "@docusaurus/plugin-content-docs": "^2.4.1",
-    "@docusaurus/plugin-content-pages": "^2.4.1",
-    "@docusaurus/preset-classic": "2.4.1",
-    "@docusaurus/remark-plugin-npm2yarn": "^2.4.1",
-    "@mdx-js/react": "^1.6.22",
+    "@docusaurus/core": "3.0.1",
+    "@docusaurus/plugin-content-docs": "3.0.1",
+    "@docusaurus/plugin-content-pages": "3.0.1",
+    "@docusaurus/preset-classic": "3.0.1",
+    "@docusaurus/remark-plugin-npm2yarn": "3.0.1",
+    "@mdx-js/react": "3.0.0",
     "@saucelabs/theme-github-codeblock": "^0.2.3",
-    "clsx": "^1.2.1",
-    "prism-react-renderer": "^1.3.5",
+    "clsx": "^2.0.0",
+    "prism-react-renderer": "^2.1.0",
     "raw-loader": "^4.0.2",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-router-dom": "5.3.4",
-    "remark-code-import": "0.4.0"
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "remark-code-import": "1.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.1",
-    "@tsconfig/docusaurus": "^1.0.5",
-    "docusaurus-plugin-typedoc": "^0.19.2",
-    "typedoc": "^0.24.8",
+    "@docusaurus/module-type-aliases": "3.0.1",
+    "@docusaurus/tsconfig": "3.0.1",
+    "docusaurus-plugin-typedoc": "^0.22.0",
+    "typedoc": "^0.25.5",
     "typedoc-plugin-markdown": "^3.17.1",
-    "typescript": "4.9.5"
+    "typescript": "5.3.3"
   },
   "browserslist": {
     "production": [

docs/src/pages/index.tsx

@@ -1,9 +1,8 @@
+import { Redirect } from '@docusaurus/router';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import HomepageFeatures from '@site/src/components/HomepageFeatures';
 import Layout from '@theme/Layout';
 import clsx from 'clsx';
-import React from 'react';
-import { Redirect } from 'react-router-dom';
 import styles from './index.module.css';
 
 function HomepageHeader() {
@@ -21,7 +20,7 @@ export default function Home(): JSX.Element {
   const { siteConfig } = useDocusaurusContext();
   // Temporary until homepage developed.
   return <Redirect to='/docs/overview' />;
-  
+
   return (
     <Layout
       title={`Welcome to ${siteConfig.title}`}

docs/tsconfig.json

@@ -1,6 +1,6 @@
 {
   // This file is not used in compilation. It is here just for a nice editor experience.
-  "extends": "@tsconfig/docusaurus/tsconfig.json",
+  "extends": "@docusaurus/tsconfig",
   "compilerOptions": {
     "baseUrl": "."
   }