[Don't merge] feat: implemented algolia search with custom improvements

.env.example

@@ -0,0 +1,4 @@
+ALGOLIA_APP_ID=
+ALGOLIA_API_KEY=
+ALGOLIA_INDEX_NAME=
+DOCS_BASE_URL=

.github/workflows/build.yml

@@ -23,3 +23,7 @@ jobs:
         run: npm ci
       - name: Build Project
         run: npm run build
+        env:
+          ALGOLIA_APP_ID: ${{ vars.ALGOLIA_APP_ID }}
+          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+          ALGOLIA_INDEX_NAME: ${{ vars.ALGOLIA_INDEX_NAME }}

.github/workflows/deploy.yml

@@ -43,6 +43,10 @@ jobs:
 
       - name: Build Project
         run: npm run build
+        env:
+          ALGOLIA_APP_ID: ${{ vars.ALGOLIA_APP_ID }}
+          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+          ALGOLIA_INDEX_NAME: ${{ vars.ALGOLIA_INDEX_NAME }}
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

.gitignore

@@ -14,6 +14,11 @@
 .env.development.local
 .env.test.local
 .env.production.local
+.env.algolia
+
+# Algolia PoC (temporary)
+docsearch-config.json
+algolia-records.json
 
 npm-debug.log*
 yarn-debug.log*
@@ -24,4 +29,7 @@ yarn-error.log*
 .cursor
 .vscode
 .idea
+
+.env
+.env.local
 .claude

docusaurus.config.js

@@ -17,6 +17,7 @@ module.exports = async function createConfigAsync() {
       },
     },
     themes: ['@docusaurus/theme-mermaid'],
+    clientModules: ['./src/clientModules/searchHighlight.js', './src/clientModules/searchQueryPersist.js'],
     stylesheets: [
       {
         href: 'https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css',
@@ -64,9 +65,23 @@ module.exports = async function createConfigAsync() {
             href: 'https://github.com/lidofinance',
             label: 'GitHub',
             position: 'right',
-          }
+          },
         ],
       },
+      algolia: {
+        appId: process.env.ALGOLIA_APP_ID || 'A2HCNXVT4O',
+        apiKey: process.env.ALGOLIA_API_KEY || '',
+        indexName: process.env.ALGOLIA_INDEX_NAME || 'dev_LIDO_DOCS',
+        contextualSearch: false,
+        searchPagePath: 'search',
+        searchParameters: {
+          distinct: 3,
+          exactOnSingleWordQuery: 'none',
+          removeWordsIfNoResults: 'lastWords',
+          ignorePlurals: true,
+          queryLanguages: ['en'],
+        },
+      },
     },
     presets: [
       [
@@ -86,10 +101,10 @@ module.exports = async function createConfigAsync() {
       ],
     ],
     plugins: [
-      [
-        require.resolve('@easyops-cn/docusaurus-search-local'),
-        { indexBlog: false, docsRouteBasePath: '/', indexPages: true },
-      ],
+      // [
+      //   require.resolve('@easyops-cn/docusaurus-search-local'),
+      //   { indexBlog: false, docsRouteBasePath: '/', indexPages: true },
+      // ],
       [
         '@docusaurus/plugin-client-redirects',
         {
@@ -108,10 +123,7 @@ module.exports = async function createConfigAsync() {
             },
             {
               to: '/run-on-lido/stvaults/tech-documentation/pdg',
-              from: [
-                '/guides/stvaults/pdg',
-                '/run-on-lido/stvaults/pdg',
-              ],
+              from: ['/guides/stvaults/pdg', '/run-on-lido/stvaults/pdg'],
             },
             {
               to: '/run-on-lido/stvaults/operational-and-management-guides/health-monitoring-guide',
@@ -179,5 +191,5 @@ module.exports = async function createConfigAsync() {
         },
       ],
     ],
-  };
-};
+  }
+}