Merge pull request #2237 from reduxjs/docs/search-pagefind

Update docs to Docusaurus v3 and switch search to Canary + Pagefind

Author: markerikson

website/docusaurus.config.js renamed to website/docusaurus.config.ts

@@ -5,10 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import { resolve } from 'path'
+import type { Options, ThemeConfig } from '@docusaurus/preset-classic'
+import type { Config } from '@docusaurus/types'
+import type { Options as UmamiOptions } from '@dipakparmar/docusaurus-plugin-umami'
+
 // See https://docusaurus.io/docs/site-config for all the possible
 // site configuration options.
 
-const siteConfig = {
+const siteConfig: Config = {
   presets: [
     [
       '@docusaurus/preset-classic',
@@ -31,7 +36,7 @@ const siteConfig = {
             require.resolve('./static/css/codeblock.css'),
           ],
         },
-      },
+      } satisfies Options,
     ],
   ],
   title: 'React Redux', // Title for your website.
@@ -61,6 +66,7 @@ const siteConfig = {
   customFields: {
     repoUrl: 'https://github.com/reduxjs/react-redux',
   },
+  themes: [require.resolve('@getcanary/docusaurus-theme-search-pagefind')],
   themeConfig: {
     metadata: [{ name: 'twitter:card', content: 'summary' }],
     prism: {
@@ -197,27 +203,26 @@ const siteConfig = {
         },
       ],
     },
-    algolia: {
-      appId: ' ',
-      apiKey: '2d058d216b7fd5d68d481fd48ee72c06',
-      indexName: 'react-redux',
-      algoliaOptions: {},
-    },
-  },
+    // algolia: {
+    //   appId: ' ',
+    //   apiKey: '2d058d216b7fd5d68d481fd48ee72c06',
+    //   indexName: 'react-redux',
+    //   algoliaOptions: {},
+    // },
+  } satisfies ThemeConfig,
   plugins: [
     [
       '@dipakparmar/docusaurus-plugin-umami',
-      /** @type {import('@dipakparmar/docusaurus-plugin-umami').Options} */
-      ({
+      {
         websiteID: 'e81a2686-96f3-4557-9c03-f584b7e8ab6b',
         analyticsDomain: 'redux-docs-umami.up.railway.app',
         scriptName: 'script.js',
         dataAutoTrack: true,
         dataDoNotTrack: true,
         dataCache: true,
-      }),
+      } satisfies UmamiOptions,
     ],
   ],
 }
 
-module.exports = siteConfig
+export default siteConfig

website/package.json

@@ -10,13 +10,14 @@
   },
   "dependencies": {
     "@dipakparmar/docusaurus-plugin-umami": "^2.0.6",
-    "@docusaurus/core": "2.4.1",
-    "@docusaurus/preset-classic": "2.4.1",
+    "@docusaurus/core": "3.6.3",
+    "@docusaurus/preset-classic": "3.6.3",
+    "@getcanary/docusaurus-theme-search-pagefind": "^1.0.2",
+    "@getcanary/web": "^1.0.12",
     "classnames": "^2.2.6",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-lite-youtube-embed": "^2.0.3",
-    "url-search-params-polyfill": "^8.1.0"
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-lite-youtube-embed": "^2.0.3"
   },
   "devDependencies": {
     "netlify-plugin-cache": "^1.0.3"

website/sidebars.js renamed to website/sidebars.ts

@@ -1,4 +1,6 @@
-module.exports = {
+import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'
+
+const sidebars: SidebarsConfig = {
   docs: [
     {
       type: 'category',
@@ -42,3 +44,5 @@ module.exports = {
     },
   ],
 }
+
+export default sidebars