feature: docusaurus search plugin

Author: cdxker

.gitignore

@@ -82,6 +82,7 @@ data/*
 clients/ts-sdk/dist
 clients/ts-sdk/docs
 clients/search-component/dist
+clients/docusaurus-theme-search/dist
 eslint_report.json
 
 
@@ -91,4 +92,4 @@ server/migrations/2024-07-26-165058_move_config_to_table/down.sql
 server/migrations/2024-07-26-165058_move_config_to_table/up.sql
 dist/**
 
-clients/python-sdk/dist
+clients/python-sdk/dist

clients/docusaurus-theme-search/README.md

@@ -0,0 +1,46 @@
+## Adding into your site
+
+Add the following into your `docusaurus.config.js`
+
+```sh
+npm install @trieve/docusaurus-search-theme
+```
+
+```js docusaurus.config.js
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  ...
+  themes: [
+    [
+      require.resolve("@trieve/docusaurus-search-theme"),
+      {
+        apiKey: "tr-****************",
+        datasetId: "<your-dataset-id>"
+        defaultSearchQueries: [
+          "How to use the API reference?",
+          "Is there a python sdk?",
+          "How to get started?"
+        ]
+      }
+    ],
+  ],
+};
+```
+
+## Configuration options available
+
+| Name                 | Type                                                                                           | Default                                    |
+| -------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------ |
+| datasetId            | string                                                                                         | ''                                         |
+| apiKey               | string                                                                                         | ''                                         |
+| chat                 | boolean                                                                                        | true                                       |
+| analytics            | boolean                                                                                        | true                                       |
+| placeholder          | string                                                                                         | "Search..."                                |
+| theme                | "light" or "dark"                                                                              | "light"                                    |
+| searchOptions        | [AutocompleteReqPayload](https://ts-sdk.trieve.ai/types/types_gen.AutocompleteReqPayload.html) | `{ search_type: "fulltext" }`              |
+| suggestedQueries     | boolean                                                                                        | true                                       |
+| defaultSearchQueries | string[]                                                                                       | []                                         |
+| defaultAiQuestions   | string[]                                                                                       | []                                         |
+| brandLogoImgSrcUrl   | string                                                                                         | null                                       |
+| brandName            | string                                                                                         | null                                       |
+| accentColor          | string                                                                                         | #CB53EB                                    |

clients/docusaurus-theme-search/package.json

@@ -18,8 +18,6 @@
     "pub": "yarn build && yarn publish --access public"
   },
   "dependencies": {
-    "@getcanary/docusaurus-theme-search-pagefind": "^1.0.2",
-    "@getcanary/web": "^1.0.0",
     "@trieve/docusaurus-search-theme": "^0.1.0",
     "cli-progress": "^3.12.0",
     "micromatch": "^4.0.7",

clients/docusaurus-theme-search/src/index.js

@@ -0,0 +1,26 @@
+import path from "path";
+
+/**
+ * @typedef {import("@docusaurus/types").Plugin} Plugin
+ * @typedef {import("@docusaurus/types").DocusaurusContext} DocusaurusContext
+ * @typedef {import("webpack").Configuration} WebpackConfiguration
+ * @param {DocusaurusContext} context
+ */
+export default function plugin(context, options) {
+  /**
+   * @type {Plugin}
+   */
+  const config = {
+    name: "docusaurus-trieve-search-theme",
+    async contentLoaded({ actions }) {
+      actions.setGlobalData({ options });
+    },
+  };
+
+  return {
+    ...config,
+    getThemePath() {
+      return path.resolve(__dirname, "./theme");
+    },
+  };
+}

clients/docusaurus-theme-search/src/theme/SearchBar/index.jsx

@@ -0,0 +1,14 @@
+import React from "react";
+
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import { TrieveModalSearch } from "trieve-search-component";
+import "trieve-search-component/dist/index.css";
+import { usePluginData } from "@docusaurus/useGlobalData";
+
+const SearchComponent = () => {
+  const { options } = usePluginData("docusaurus-trieve-search-theme");
+
+  return <TrieveModalSearch {...options} />;
+};
+
+export default SearchComponent;