feat: typesense search

.github/workflows/typesense.yml

@@ -17,7 +17,7 @@ jobs:
 
       - run: |
           docker run -e TYPESENSE_API_KEY="${{ secrets.TYPESENSE_API_KEY }}" \
-            -e TYPESENSE_HOST="${{ secrets.TYPESENSE_HOST }}" \
+            -e TYPESENSE_HOST="typesense.test.aelf.dev" \
             -e TYPESENSE_PORT=443 \
             -e TYPESENSE_PROTOCOL=https \
             -e "CONFIG=$(cat config/typesense.json | jq -r tostring)" typesense/docsearch-scraper:0.9.1

README.md

@@ -39,3 +39,13 @@ $ GIT_USER=<Your GitHub username> yarn deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+
+### Generate search-only api key
+
+```bash
+curl 'https://typesense.test.aelf.dev/keys' \
+  -X POST \
+  -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
+  -H 'Content-Type: application/json' \
+  -d '{"description":"Search-only aelf-docs key.","actions": ["documents:search"], "collections": ["aelf-docs"]}'
+```

config/typesense-theme-config.json

@@ -0,0 +1,15 @@
+{
+  "typesenseCollectionName": "aelf-docs",
+  "typesenseServerConfig": {
+    "nodes": [
+      {
+        "host": "typesense.test.aelf.dev",
+        "port": 443,
+        "protocol": "https"
+      }
+    ],
+    "apiKey": "5zqd4xhbUfewLSGk7Veev11KXZcDRy9z"
+  },
+  "typesenseSearchParameters": {},
+  "contextualSearch": true
+}

docusaurus.config.ts

@@ -3,6 +3,7 @@ import type {Config} from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
 import footerLinks from "./config/footer-links.json";
 import navbarLinks from "./config/navbar-links.json";
+import typesenseThemeConfig from "./config/typesense-theme-config.json";
 
 const config: Config = {
   title: "AELF Docs",
@@ -51,7 +52,7 @@ const config: Config = {
       } satisfies Preset.Options,
     ],
   ],
-
+  themes: ["docusaurus-theme-search-typesense"],
   themeConfig: {
     // Replace with your project's social card
     image: "img/aelficon.png",
@@ -86,6 +87,7 @@ const config: Config = {
         hideable: true, // https://docusaurus.io/docs/sidebar#hideable-sidebar
       },
     },
+    typesense: typesenseThemeConfig,
   } satisfies Preset.ThemeConfig,
 };
 

package.json

@@ -19,6 +19,7 @@
     "@docusaurus/preset-classic": "3.4.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
+    "docusaurus-theme-search-typesense": "^0.20.0-0",
     "prism-react-renderer": "^2.3.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0"