feat: add search and version upgrades (#100)

* feat: add search and version upgrades * chore: update node version in workflows
graphops · Oct 15, 2024 · 054df11 · 054df11
1 parent 1ece73b
commit 054df11
Show file tree

Hide file tree

Showing 6 changed files with 4,767 additions and 2,424 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -15,7 +15,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v2
         with:
-          node-version: "16"
+          node-version: "18"
 
       - name: Get yarn cache
         id: yarn-cache
@@ -37,4 +37,4 @@ jobs:
         if: ${{ github.ref == 'refs/heads/main' }}
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./build
+          publish_dir: ./build
diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml
@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: "16"
+          node-version: "18"
           cache: yarn
       - name: Test build
         run: |

diff --git a/docs/graphcast/radios/listener-radio.md b/docs/graphcast/radios/listener-radio.md
@@ -39,11 +39,11 @@ You will need to prepare the following environment variables:
 
 #### Example message table
 
-| id  | message                                                                                                                                                                                                                                                                                   |
-| --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 1   | {"nonce": 1686182179, "network": "mainnet", "payload": {"content": "0x3f...", "identifier": "QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj"}, "signature": "dff1...", "block_hash": "276e...", "identifier": "QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj", "block_number": 17431860} |
-| 2   | {"nonce": 1686182183, "network": "goerli", "payload": {"content": "0xc0...", "identifier": "QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB"}, "signature": "dbd2...", "block_hash": "0198...", "identifier": "QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB", "block_number": 9140860}   |
-| ... | ...                                                                                                                                                                                                                                                                                       |
+| id  | message                                                                                                                                                                                                                                                                                     |
+| --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 1   | `{"nonce": 1686182179, "network": "mainnet", "payload": {"content": "0x3f...", "identifier": "QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj"}, "signature": "dff1...", "block_hash": "276e...", "identifier": "QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj", "block_number": 17431860}` |
+| 2   | `{"nonce": 1686182183, "network": "goerli", "payload": {"content": "0xc0...", "identifier": "QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB"}, "signature": "dbd2...", "block_hash": "0198...", "identifier": "QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB", "block_number": 9140860}`   |
+| ... | ...                                                                                                                                                                                                                                                                                         |
 
 ## Advanced Configuration
 

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -1,7 +1,7 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
-const lightCodeTheme = require("prism-react-renderer/themes/github");
-const darkCodeTheme = require("prism-react-renderer/themes/palenight");
+const lightCodeTheme = require("prism-react-renderer").themes.github;
+const darkCodeTheme = require("prism-react-renderer").themes.palenight;
 // Override code block theme
 const customDarkTheme = {
   ...darkCodeTheme,
@@ -21,7 +21,22 @@ const config = {
   projectName: "docs", // Usually your repo name.
   trailingSlash: false,
   // Waiting for docusauras canary to be released for mermaid support: https://docusaurus.io/docs/next/markdown-features/diagrams
-  themes: ['@docusaurus/theme-mermaid'],
+  themes: ["@docusaurus/theme-mermaid", 
+    [
+      "@easyops-cn/docusaurus-search-local",
+      /** @type {import("@easyops-cn/docusaurus-search-local")} */
+      ({
+          hashed: true, 
+          language: ['en'],
+          indexDocs: true, 
+          indexBlog: false,
+          docsRouteBasePath: '/', 
+          blogRouteBasePath: '/blog',
+          highlightSearchTermsOnTargetPage: true,
+          explicitSearchResultPath: true,
+      }),
+    ],
+  ],
   markdown: {
     mermaid: true,
   },
@@ -152,7 +167,7 @@ const config = {
       prism: {
         theme: lightCodeTheme,
         darkTheme: customDarkTheme,
-        additionalLanguages: ["solidity", "json5", "toml"],
+        additionalLanguages: ["solidity", "json5", "toml", "bash"],
       },
       // metadata: [ // TODO: Take screenshot for rendering previews
       //   {property: "og:image", content: "/img/image.png"},

diff --git a/package.json b/package.json
@@ -16,22 +16,23 @@
     "version": "docusaurus docs:version"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.4.1",
-    "@docusaurus/preset-classic": "^2.4.1",
-    "@docusaurus/theme-mermaid": "^2.4.1",
-    "@mdx-js/react": "^1",
+    "@docusaurus/core": "3.5.2",
+    "@docusaurus/preset-classic": "3.5.2",
+    "@docusaurus/theme-mermaid": "3.5.2",
+    "@easyops-cn/docusaurus-search-local": "^0.45.0",
+    "@mdx-js/react": "^3.0.0",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
     "file-loader": "^6.2.0",
-    "prism-react-renderer": "^1.2.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
+    "prism-react-renderer": "^2.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "url-loader": "^4.1.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.4.1",
-    "@tsconfig/docusaurus": "^1.0.4",
-    "typescript": "^4.3.5"
+    "@docusaurus/module-type-aliases": "3.5.2",
+    "@docusaurus/tsconfig": "3.5.2",
+    "typescript": "~5.2.2"
   },
   "browserslist": {
     "production": [