refactor: upgrading Docusaurus to v3 (#374)

* upgrading to v3 Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * correcting the mdx Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * removing remark plugins Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * correcting some files Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * adding the commented code Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * removing the plugin Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * trying nodejs version 18 Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * errors Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * resolving anchors Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * swizzling the heading component Signed-off-by: Aditya-eddy <aditya282003@gmail.com> --------- Signed-off-by: Aditya-eddy <aditya282003@gmail.com> Co-authored-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com> Co-authored-by: Neha Gupta <gneha21@yahoo.in>
keploy · May 28, 2024 · 6d52cfc · 6d52cfc
1 parent 30b49a0
commit 6d52cfc
Show file tree

Hide file tree

Showing 26 changed files with 3,847 additions and 2,740 deletions.
diff --git a/.github/workflows/build_and_check.yml b/.github/workflows/build_and_check.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: 16.14
+          node-version: 18.0.0
 
       - name: Install Yarn
         run: npm install -g yarn

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -11,7 +11,7 @@ on:
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a single job called "build"
-  build:
+  build:    
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
     env:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -35,7 +35,7 @@ The command starts a local development server and opens a browser window.
 
 <br/>
 
-2. Clone the repository with the following command. Replace the <GITHUB_USERNAME> with your username
+2. Clone the repository with the following command. Replace the {'<'}GITHUB_USERNAME{'>'} with your username
 
 ```sh
 git clone https://github.com/<GITHUB_USERNAME>/docs.git

diff --git a/README.md b/README.md
@@ -14,15 +14,20 @@ Repository for the Keploy documentation website.
 
 <p align="center">
 <a href="https://github.com/keploy/docs" alt="GitHub contributors">
-<img src="https://img.shields.io/github/contributors/keploy/docs.svg" /><a>
+<img src="https://img.shields.io/github/contributors/keploy/docs.svg" />
+</a>
 <a href="https://github.com/keploy/docs" alt="GitHub issues by-label">
-<img src="https://img.shields.io/github/issues/keploy/docs" /></a>
+<img src="https://img.shields.io/github/issues/keploy/docs" />
+</a>
 <a href="https://keploy.slack.com/" alt="Slack">
-<img src="https://img.shields.io/badge/Slack-@layer5.svg?logo=slack" /></a>
+<img src="https://img.shields.io/badge/Slack-@layer5.svg?logo=slack" />
+</a>
 <a href="https://twitter.com/Keployio" alt="Twitter Follow">
-<img src="https://img.shields.io/twitter/follow/keploy.svg?label=Follow&style=social" /></a>
+<img src="https://img.shields.io/twitter/follow/keploy.svg?label=Follow&style=social" />
+</a>
 <a href="https://github.com/keploy/docs" alt="License">
-<img src="https://img.shields.io/github/license/keploy/docs.svg" /></a>
+<img src="https://img.shields.io/github/license/keploy/docs.svg" />
+</a>
 </p>
 
 [Keploy](https://keploy.io) is a no-code testing platform that generates tests from API calls.
@@ -75,7 +80,7 @@ The command starts a local development server and opens a browser window.
 
 <br/>
 
-2. Clone the repository with the following command. Replace the <GITHUB_USERNAME> with your username
+2. Clone the repository with the following command. Replace the {'<'}GITHUB_USERNAME{'>'} with your username
 
 ```sh
 git clone https://github.com/<GITHUB_USERNAME>/docs.git

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -1,6 +1,8 @@
 //@ts-check
+
+import {themes as prismThemes} from "prism-react-renderer";
 const path = require("path");
-const visit = require("unist-util-visit");
+import {visit} from "unist-util-visit";
 const FontPreloadPlugin = require("webpack-font-preload-plugin");
 
 /** @type {import('@docusaurus/types').DocusaurusConfig} */
@@ -100,9 +102,9 @@ module.exports = {
       content: `⭐️ If you like Keploy, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/keploy/keploy">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/keployio">Twitter</a> ❤️ `,
     },
     prism: {
-      theme: require("prism-react-renderer/themes/vsLight"),
-      darkTheme: require("prism-react-renderer/themes/dracula"),
-      additionalLanguages: ["java", "ruby", "php"],
+      theme: prismThemes.vsLight,
+      darkTheme: prismThemes.dracula,
+      additionalLanguages: ["java", "ruby", "php", "bash"],
     },
     // hideableSidebar: true,
     navbar: {
@@ -245,25 +247,6 @@ module.exports = {
                 },
               {},
             ],
-            [
-              require("remark-typescript-tools").transpileCodeblocks,
-              {
-                compilerSettings: {
-                  tsconfig: path.join(
-                    __dirname,
-                    "docs",
-                    "typescript",
-                    "tsconfig.json"
-                  ),
-                  externalResolutions: {},
-                },
-                fileExtensions: [".md", ".mdx"],
-                // remark-typescript-tools automatically running prettier with a custom config that doesn't
-                // line up with ours. This disables any post processing, including the default prettier step.
-                postProcessTs: (files) => files,
-                postProcessTranspiledJs: (files) => files,
-              },
-            ],
             [
               () =>
                 function removeTSNoCheck(tree) {

diff --git a/package.json b/package.json
@@ -19,34 +19,35 @@
     "**/*": "prettier --write --ignore-unknown"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.4.1",
-    "@docusaurus/plugin-sitemap": "^2.4.1",
-    "@docusaurus/preset-classic": "^2.0.0-beta.16",
-    "@mdx-js/react": "^1.5.8",
-    "clsx": "^1.1.1",
+    "@docusaurus/core": "^3.2.1",
+    "@docusaurus/plugin-sitemap": "^3.2.1",
+    "@docusaurus/preset-classic": "^3.2.1",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^2.0.0",
     "lint": "^0.8.19",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "react-player": "^2.6.0",
+    "prism-react-renderer": "^2.1.0",
     "remark-typescript-tools": "1.0.9",
-    "typescript": "4.x",
+    "typescript": "5",
     "uuid": "^8.3.2",
     "webpack-font-preload-plugin": "^1.5.0"
   },
   "browserslist": {
     "production": [
-      ">0.2%",
+      ">0.5%",
       "not dead",
       "not op_mini all"
     ],
     "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
+      "last 3 chrome version",
+      "last 3 firefox version",
+      "last 5 safari version"
     ]
   },
   "devDependencies": {
-    "@docusaurus/plugin-client-redirects": "^2.4.1",
+    "@docusaurus/plugin-client-redirects": "^3.2.1",
     "@tailwindcss/typography": "^0.5.0",
     "autoprefixer": "^10.4.0",
     "docusaurus": "^1.14.7",
@@ -61,5 +62,8 @@
     "prettier": "^2.5.1",
     "prettier-plugin-tailwindcss": "^0.1.4",
     "tailwindcss": "^3.0.1"
+  },
+  "engines": {
+    "node":">=18.0"
   }
 }
diff --git a/src/theme/BlogLayout/index.js b/src/theme/BlogLayout/index.js