feat: add algolia search support (#34)

Author: JounQin

.changeset/witty-carrots-repair.md

@@ -0,0 +1,5 @@
+---
+"@alauda/doom": minor
+---
+
+feat: add algolia search support

docs/public/Robots.txt

@@ -0,0 +1 @@
+# Algolia-Crawler-Verif: 7A640E13F04C80C2

doom.config.yml

@@ -1,6 +1,12 @@
 lang: zh
 title: Doom
 logoText: Doom
+themeConfig:
+  socialLinks:
+    - icon: github
+      mode: link
+      content: https://github.com/alauda/doom
+
 api:
   crds:
     - docs/shared/crds/*.yaml
@@ -25,8 +31,7 @@ lint:
     cspell:
       words:
         - katanomi
-themeConfig:
-  socialLinks:
-    - icon: github
-      mode: link
-      content: https://github.com/alauda/doom
+algolia:
+  appId:
+  apiKey:
+  indexName:

package.json

@@ -15,6 +15,7 @@
     "./package.json": "./package.json",
     "./config": "./lib/config.js",
     "./runtime": "./lib/runtime/index.js",
+    "./theme": "./lib/theme.js",
     "./types": "./lib/types.js"
   },
   "files": [
@@ -64,6 +65,7 @@
     "@rsbuild/plugin-sass": "^1.3.1",
     "@rsbuild/plugin-yaml": "^1.0.2",
     "@rspress/core": "2.0.0-beta.8",
+    "@rspress/plugin-algolia": "2.0.0-beta.8",
     "@shikijs/transformers": "^3.4.2",
     "chokidar": "^4.0.3",
     "cli-progress": "^3.12.0",
@@ -96,7 +98,7 @@
     "swagger2openapi": "^7.0.8",
     "tinyglobby": "^0.2.14",
     "type-fest": "^4.41.0",
-    "typescript-eslint": "^8.32.1",
+    "typescript-eslint": "^8.33.0",
     "x-fetch": "^0.2.6",
     "yaml": "^2.8.0",
     "yoctocolors": "^2.1.1"
@@ -110,7 +112,7 @@
     "@total-typescript/ts-reset": "^0.6.1",
     "@types/cli-progress": "^3.11.6",
     "@types/ejs": "^3.1.5",
-    "@types/node": "^22.15.21",
+    "@types/node": "^22.15.23",
     "@types/picomatch": "^4.0.0",
     "@types/react": "^19.1.6",
     "@types/react-dom": "^19.1.5",

src/cli/index.ts

@@ -103,6 +103,12 @@ program
       FALSY_VALUES.has(value) ? false : TRUTHY_VALUES.has(value) || value,
     false,
   )
+  .option(
+    '-a, --algolia',
+    'Whether to enable Algolia search',
+    parseBoolean,
+    false,
+  )
   .option(
     '-n, --no-open [boolean]',
     'Do not open the browser after starting the server',

src/cli/load-config.ts

@@ -114,6 +114,7 @@ const getCommonConfig = async ({
   exclude,
   redirect,
   editRepo,
+  algolia,
 }: {
   config: UserConfig
   configFilePath?: string
@@ -130,6 +131,7 @@ const getCommonConfig = async ({
   exclude?: string[]
   redirect?: 'auto' | 'never' | 'only-default-lang'
   editRepo?: boolean | string
+  algolia?: boolean
 }): Promise<UserConfig> => {
   const fallbackToZh = 'lang' in config && !config.lang
   root = resolveDocRoot(CWD, root, config.root)
@@ -285,12 +287,30 @@ const getCommonConfig = async ({
         open,
       },
       tools: {
-        rspack: {
-          resolve: {
-            extensionAlias: {
-              '.js': ['.ts', '.tsx', '.js'],
+        rspack(rspackConfig, { mergeConfig, rspack }) {
+          return mergeConfig(rspackConfig, {
+            resolve: {
+              extensionAlias: {
+                '.js': ['.ts', '.tsx', '.js'],
+              },
             },
-          },
+            plugins:
+              algolia && config.algolia
+                ? [
+                    new rspack.DefinePlugin({
+                      'process.env.ALGOLIA_APP_ID': JSON.stringify(
+                        config.algolia.appId,
+                      ),
+                      'process.env.ALGOLIA_API_KEY': JSON.stringify(
+                        config.algolia.apiKey,
+                      ),
+                      'process.env.ALGOLIA_INDEX_NAME': JSON.stringify(
+                        config.algolia.indexName,
+                      ),
+                    }),
+                  ]
+                : undefined,
+          })
         },
       },
     },
@@ -323,6 +343,7 @@ export async function loadConfig(
     outDir,
     redirect,
     editRepo,
+    algolia,
   }: GlobalCliOptions = {},
 ): Promise<{
   config: UserConfig
@@ -402,6 +423,7 @@ export async function loadConfig(
     exclude,
     redirect,
     editRepo,
+    algolia,
   })
 
   base = commonConfig.base!

src/theme.tsx

@@ -0,0 +1,22 @@
+import { Search as OriginalSearch } from '@rspress/core/theme'
+import { Search as AlgoliaSearch } from '@rspress/plugin-algolia/runtime'
+
+const Search =
+  process.env.ALGOLIA_APP_ID &&
+  process.env.ALGOLIA_API_KEY &&
+  process.env.ALGOLIA_INDEX_NAME
+    ? () => (
+        <AlgoliaSearch
+          docSearchProps={{
+            appId: process.env.ALGOLIA_APP_ID!,
+            apiKey: process.env.ALGOLIA_API_KEY!,
+            indexName: process.env.ALGOLIA_INDEX_NAME!,
+          }}
+        />
+      )
+    : OriginalSearch
+
+// eslint-disable-next-line import-x/export
+export * from '@rspress/core/theme'
+// eslint-disable-next-line import-x/export
+export { Search }

src/types.ts

@@ -30,6 +30,7 @@ export interface GlobalCliOptions {
   outDir?: string
   redirect?: 'auto' | 'never' | 'only-default-lang'
   editRepo?: boolean | string
+  algolia?: boolean
 }
 
 export interface TranslateOptions {
@@ -41,6 +42,12 @@ export interface LintOptions {
   cspellOptions?: Partial<Options>
 }
 
+export interface AlgoliaOptions {
+  appId: string
+  apiKey: string
+  indexName: string
+}
+
 declare module '@rspress/shared' {
   interface UserConfig {
     prefix?: string
@@ -56,6 +63,7 @@ declare module '@rspress/shared' {
     translate?: TranslateOptions
     editRepoBaseUrl?: string
     lint?: LintOptions
+    algolia?: AlgoliaOptions
   }
 
   interface SiteData {

theme/index.ts

@@ -0,0 +1 @@
+export * from '@alauda/doom/theme'

tsconfig.json

@@ -12,7 +12,8 @@
     "target": "ESNext",
     "paths": {
       "@alauda/doom/config": ["./src/config.ts"],
-      "@alauda/doom/runtime": ["./src/runtime/index.ts"]
+      "@alauda/doom/runtime": ["./src/runtime/index.ts"],
+      "@alauda/doom/theme": ["./src/theme.tsx"]
     },
     "stripInternal": true,
     "verbatimModuleSyntax": true