Merge pull request #308 from HarperDB/algolia-search

wire up algolia search for prod build with necessary env vars

Author: heskew

.github/workflows/deploy.yaml

@@ -53,6 +53,9 @@ jobs:
           DOCUSAURUS_ROUTE_BASE_PATH: ${{ vars.DOCUSAURUS_ROUTE_BASE_PATH }}
           DOCUSAURUS_BASE_URL: ${{ vars.DOCUSAURUS_BASE_URL }}
           DOCUSAURUS_URL: ${{ vars.DOCUSAURUS_URL }}
+          ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
+          ALGOLIA_SEARCH_KEY: ${{ secrets.ALGOLIA_SEARCH_KEY }}
+          ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
         run: |
           echo "Building Docusaurus site..."
           echo "Using DOCUSAURUS_ROUTE_BASE_PATH: $DOCUSAURUS_ROUTE_BASE_PATH"

docusaurus.config.ts

@@ -230,21 +230,25 @@ const config: Config = {
 	],
 
 	themes: [
-		[
-			require.resolve('@easyops-cn/docusaurus-search-local'),
-			{
-				hashed: true,
-				language: ['en'],
-				indexDocs: true,
-				indexBlog: false,
-				indexPages: false,
-				docsRouteBasePath: routeBasePath,
-				highlightSearchTermsOnTargetPage: true,
-				searchResultLimits: 8,
-				// Explicitly set the search bar position
-				searchBarPosition: 'right',
-			},
-		],
+		// Use Algolia search in production when env vars are set, otherwise use local search
+		...(process.env.NODE_ENV === 'production' && process.env.ALGOLIA_APP_ID && process.env.ALGOLIA_SEARCH_KEY
+			? ['@docusaurus/theme-search-algolia']
+			: [
+					[
+						require.resolve('@easyops-cn/docusaurus-search-local'),
+						{
+							hashed: true,
+							language: ['en'],
+							indexDocs: true,
+							indexBlog: false,
+							indexPages: true,
+							docsRouteBasePath: routeBasePath,
+							highlightSearchTermsOnTargetPage: true,
+							searchResultLimits: 8,
+							searchBarPosition: 'right',
+						},
+					],
+				]),
 		'@docusaurus/theme-mermaid',
 	],
 
@@ -255,6 +259,15 @@ const config: Config = {
 	themeConfig: {
 		// Project's social card
 		image: 'img/HarperOpenGraph.png',
+		// Algolia search configuration (only used when Algolia theme is active)
+		algolia: {
+			appId: process.env.ALGOLIA_APP_ID || '',
+			apiKey: process.env.ALGOLIA_SEARCH_KEY || '',
+			indexName: process.env.ALGOLIA_INDEX_NAME || 'harper-docs',
+			contextualSearch: true,
+			searchPagePath: 'search',
+			searchParameters: {},
+		},
 		navbar: {
 			logo: {
 				alt: 'Harper Logo',

package-lock.json

@@ -20,25 +20,26 @@
 		"lint": "echo 0;"
 	},
 	"dependencies": {
-		"@docusaurus/core": "^3.8.1",
-		"@docusaurus/plugin-client-redirects": "^3.8.1",
-		"@docusaurus/preset-classic": "^3.8.1",
-		"@docusaurus/remark-plugin-npm2yarn": "^3.8.1",
-		"@docusaurus/theme-mermaid": "^3.8.1",
-		"@easyops-cn/docusaurus-search-local": "^0.52.1",
-		"@mdx-js/react": "^3.0.0",
-		"clsx": "^2.0.0",
-		"prism-react-renderer": "^2.3.0",
-		"react": "^19.1.1",
-		"react-dom": "^19.1.1"
+		"@docusaurus/core": "3.8.1",
+		"@docusaurus/plugin-client-redirects": "3.8.1",
+		"@docusaurus/preset-classic": "3.8.1",
+		"@docusaurus/remark-plugin-npm2yarn": "3.8.1",
+		"@docusaurus/theme-mermaid": "3.8.1",
+		"@docusaurus/theme-search-algolia": "3.8.1",
+		"@easyops-cn/docusaurus-search-local": "0.52.1",
+		"@mdx-js/react": "3.1.0",
+		"clsx": "2.1.1",
+		"prism-react-renderer": "2.4.1",
+		"react": "19.1.1",
+		"react-dom": "19.1.1"
 	},
 	"devDependencies": {
-		"@docusaurus/module-type-aliases": "^3.8.1",
-		"@docusaurus/tsconfig": "^3.8.1",
-		"@docusaurus/types": "^3.8.1",
-		"@harperdb/code-guidelines": "^0.0.2",
-		"prettier": "^3.6.1",
-		"typescript": "^5.9.2"
+		"@docusaurus/module-type-aliases": "3.8.1",
+		"@docusaurus/tsconfig": "3.8.1",
+		"@docusaurus/types": "3.8.1",
+		"@harperdb/code-guidelines": "0.0.2",
+		"prettier": "3.6.1",
+		"typescript": "5.9.2"
 	},
 	"browserslist": {
 		"production": [