fix(algolia): add insights property on Algolia Theme Config object TS…

… definition (#10048) Co-authored-by: sebastien <[email protected]>
facebook · Apr 18, 2024 · 8e084ef · 8e084ef
1 parent 01ffcd9
commit 8e084ef
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 6 deletions.
diff --git a/.github/workflows/lint-autofix.yml b/.github/workflows/lint-autofix.yml
@@ -39,6 +39,9 @@ jobs:
       - name: AutoFix Spelling
         run: yarn lint:spelling:fix
 
+      - name: Print Diff
+        run: git diff
+
       - uses: stefanzweifel/git-auto-commit-action@v5
         with:
           commit_message: 'refactor: apply lint autofix'
diff --git a/package.json b/package.json
@@ -53,7 +53,7 @@
     "lint:js": "eslint --cache --report-unused-disable-directives \"**/*.{js,jsx,ts,tsx,mjs}\"",
     "lint:js:fix": "yarn lint:js --fix",
     "lint:spelling": "cspell \"**\" --no-progress --show-context --show-suggestions",
-    "lint:spelling:fix": "yarn rimraf project-words.txt && echo \"# Project Words - DO NOT TOUCH - This is updated through CI\" >> project-words.txt && yarn -s lint:spelling --words-only --unique --no-exit-code --no-summary \"**\" | sort --ignore-case >> project-words.txt",
+    "lint:spelling:fix": "yarn rimraf project-words.txt && echo \"# Project Words - DO NOT TOUCH - This is updated through CI\" >> project-words.txt && yarn -s lint:spelling --words-only --unique --no-exit-code --no-summary \"**\" | cross-env LC_ALL=en_US.UTF-8 sort --ignore-case >> project-words.txt",
     "lint:style": "stylelint \"**/*.css\"",
     "lint:style:fix": "yarn lint:style --fix",
     "lerna": "lerna",

diff --git a/packages/docusaurus-theme-search-algolia/src/theme-search-algolia.d.ts b/packages/docusaurus-theme-search-algolia/src/theme-search-algolia.d.ts
@@ -21,6 +21,7 @@ declare module '@docusaurus/theme-search-algolia' {
         from: string;
         to: string;
       };
+      insights?: boolean;
     };
   };
   export type UserThemeConfig = DeepPartial<ThemeConfig>;

diff --git a/project-words.txt b/project-words.txt
@@ -67,9 +67,11 @@ Datagit
 datagit
 Datagit's
 dedup
+Déja
 devto
 dingers
 Dmitry
+Docsearch
 docsearch
 Docsify
 Docu
@@ -83,7 +85,6 @@ dogfooding
 Dojocat
 Dyte
 dyte
-Déja
 easyops
 Endi
 endi
@@ -118,14 +119,14 @@ Hamel
 Hasura
 hasura
 Heavener
+Héctor
+héllô
 Hideable
 hideable
 hola
 Hostman
 hoverable
 Husain
-Héctor
-héllô
 IANAD
 idempotency
 Iframes
@@ -220,6 +221,7 @@ noninteractive
 npmjs
 nprogress
 Nuxt
+ödingers
 opensearch
 opensearchdescription
 opensource
@@ -305,6 +307,7 @@ saurus
 Scaleway
 Sebastien
 sebastien
+Sébastien
 sebastienlorber
 sensical
 setaf
@@ -350,7 +353,6 @@ supabase
 SVGR
 svgr
 swizzlable
-Sébastien
 Teik
 templating
 Thanos
@@ -408,4 +410,3 @@ yangshunz
 Zhou
 zoomable
 zpao
-ödingers
diff --git a/website/docs/search.mdx b/website/docs/search.mdx
@@ -124,6 +124,9 @@ export default {
       // Optional: path for search page that enabled by default (`false` to disable it)
       searchPagePath: 'search',
 
+      // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
+      insights: false,
+
       //... other Algolia params
     },
     // highlight-end

diff --git a/website/versioned_docs/version-2.x/search.mdx b/website/versioned_docs/version-2.x/search.mdx
@@ -116,6 +116,9 @@ module.exports = {
       // Optional: path for search page that enabled by default (`false` to disable it)
       searchPagePath: 'search',
 
+      // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
+      insights: false,
+
       //... other Algolia params
     },
     // highlight-end

diff --git a/website/versioned_docs/version-3.0.1/search.mdx b/website/versioned_docs/version-3.0.1/search.mdx
@@ -116,6 +116,9 @@ export default {
       // Optional: path for search page that enabled by default (`false` to disable it)
       searchPagePath: 'search',
 
+      // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
+      insights: false,
+
       //... other Algolia params
     },
     // highlight-end

diff --git a/website/versioned_docs/version-3.1.1/search.mdx b/website/versioned_docs/version-3.1.1/search.mdx
@@ -116,6 +116,9 @@ export default {
       // Optional: path for search page that enabled by default (`false` to disable it)
       searchPagePath: 'search',
 
+      // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
+      insights: false,
+
       //... other Algolia params
     },
     // highlight-end

diff --git a/website/versioned_docs/version-3.2.1/search.mdx b/website/versioned_docs/version-3.2.1/search.mdx
@@ -124,6 +124,9 @@ export default {
       // Optional: path for search page that enabled by default (`false` to disable it)
       searchPagePath: 'search',
 
+      // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
+      insights: false,
+
       //... other Algolia params
     },
     // highlight-end