docs(website): Add a local search plugin

Add `@easyops-cn/docusaurus-search-local` [1] as a local search plugin for Docusaurus. Fixes #1673. [1]: https://github.com/easyops-cn/docusaurus-search-local Signed-off-by: Martin Nonnenmacher <[email protected]>
eclipse-apoapsis · Jan 15, 2025 · 07e67f2 · 07e67f2
1 parent 30e847b
commit 07e67f2
Show file tree

Hide file tree

Showing 3 changed files with 465 additions and 26 deletions.
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -84,7 +84,22 @@ const config: Config = {
     ],
   ],
 
-  themes: ['@docusaurus/theme-mermaid', 'docusaurus-theme-openapi-docs'],
+  themes: [
+    '@docusaurus/theme-mermaid',
+    'docusaurus-theme-openapi-docs',
+    [
+      '@easyops-cn/docusaurus-search-local',
+      {
+        hashed: true,
+        indexBlog: false,
+        docsDir: ['api', 'docs'],
+        docsRouteBasePath: ['/api', '/docs'],
+        searchResultLimits: 15,
+        searchResultContextMaxLength: 200,
+        explicitSearchResultPath: true,
+      },
+    ],
+  ],
 
   themeConfig: {
     image: 'img/social-card.png',

diff --git a/website/package.json b/website/package.json
@@ -23,6 +23,7 @@
     "@docusaurus/preset-classic": "3.7.0",
     "@docusaurus/theme-common": "3.7.0",
     "@docusaurus/theme-mermaid": "3.7.0",
+    "@easyops-cn/docusaurus-search-local": "^0.48.0",
     "@iconify/react": "^5.0.2",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",