0.1.17 • Published 8 months ago

@trieve/docusaurus-search-theme v0.1.17

Weekly downloads
-
License
MIT
Repository
-
Last release
8 months ago

Adding into your site

Add the following into your docusaurus.config.js

npm install @trieve/docusaurus-search-theme
/** @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

NameTypeDefault
datasetIdstring''
apiKeystring''
chatbooleantrue
analyticsbooleantrue
placeholderstring"Search..."
theme"light" or "dark""light"
searchOptionsAutocompleteReqPayload{ search_type: "fulltext" }
suggestedQueriesbooleantrue
defaultSearchQueriesstring[][]
defaultAiQuestionsstring[][]
brandLogoImgSrcUrlstringnull
brandNamestringnull
accentColorstring#CB53EB

Local Development Guide

Run component Build script

clients/docusaurus-theme-search $ yarn dev

Run Example Docusarus application

This may also need to be fully restarted for the theme to update, this will automatically pull from dist/index.js. Some changes get update without a restart but not all.

clients/docusaurus-theme-search/example $ npm run start

Publishing

DO NOT RUN yarn publish, instead run yarn pub

0.1.17

8 months ago

0.1.15

9 months ago

0.1.16

9 months ago

0.1.14

9 months ago

0.1.10

9 months ago

0.1.11

9 months ago

0.1.12

9 months ago

0.1.13

9 months ago

0.1.8

9 months ago

0.1.7

9 months ago

0.1.9

9 months ago

0.1.6

9 months ago

0.1.5

9 months ago

0.1.4

9 months ago

0.1.3

9 months ago

0.1.2

9 months ago

0.1.1

9 months ago

0.1.0

9 months ago