Merge pull request #162 from NMFS-RADFish/160-docs---research-search-feature

160 Docusaurus-search-local plugin working

Author: theangchen

.github/workflows/deploy.yml

@@ -15,12 +15,11 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 18
-          cache: yarn
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Build website
-        run: yarn build
+        run: npm run build
 
       - name: Upload Build Artifact
         uses: actions/upload-pages-artifact@v3

.github/workflows/test-deploy.yml

@@ -18,9 +18,8 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 18
-          cache: yarn
 
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
+        run: npm install
       - name: Test build website
-        run: yarn build
+        run: npm run build

docusaurus.config.js

@@ -51,6 +51,13 @@ const config = {
     ],
   ],
   plugins: [
+    [
+      require.resolve("@cmfcmf/docusaurus-search-local"),
+      {
+        indexBlog: false,
+        // Options here
+      },
+    ],
     [
       "docusaurus-plugin-remote-content",
       {

package-lock.json

@@ -14,6 +14,7 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
+    "@cmfcmf/docusaurus-search-local": "^1.2.0",
     "@docusaurus/core": "^3.5.2",
     "@docusaurus/preset-classic": "^3.5.2",
     "@mdx-js/react": "^3.0.0",
@@ -41,5 +42,10 @@
   },
   "engines": {
     "node": ">=18.0"
+  },
+  "overrides": {
+    "@cmfcmf/docusaurus-search-local": {
+      "@docusaurus/core": "^3.1.0"
+    }
   }
 }

package.json

@@ -25,6 +25,9 @@
   --ifm-color-secondary-light: #19daf9;
   --ifm-color-secondary-lighter: #25dcfa;
   --ifm-color-secondary-lightest: #49e2fb;
+
+  /* Search box icon & focus. Same color as --radfish-primary-blue */
+  --aa-primary-color-rgb: 32, 84, 147 !important;
 }
 
 /* For readability concerns, you should choose a lighter palette in dark mode. */
@@ -37,6 +40,14 @@
   --ifm-color-primary-lighter: #32d8b4;
   --ifm-color-primary-lightest: #4fddbf;
   --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+
+  /* Search box icon & focus. Same color as --ifm-color-secondary */
+  --aa-primary-color-rgb: 6, 210, 243 !important;
+  /* Search box border & selected color: blue  */
+  --aa-input-border-color-rgb: 221, 221, 221 !important;
+  --aa-selected-color-rgb: 32, 84, 147 !important;
+  /* Search text. Same color as --radfish-gray-light */
+  --aa-muted-color-rgb: 102, 102, 102 !important;
 }
 
 .buttons {
@@ -74,4 +85,4 @@
 
 .button--secondary:hover {
   background-color: var(--ifm-color-secondary-light);
-}
+}