✨ update to docusaurus 3.8.1 (#15)

StarHeartHunt · web-flow · commit bfd77f7d11b7 · 2025-08-24T18:03:13.000+08:00
diff --git a/packages/plugin-changelog/package.json b/packages/plugin-changelog/package.json
@@ -18,13 +18,13 @@
     "watch": "tsc --build --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "3.7.0",
-    "@docusaurus/plugin-content-docs": "3.7.0",
-    "@docusaurus/utils-validation": "3.7.0",
+    "@docusaurus/core": "3.8.1",
+    "@docusaurus/plugin-content-docs": "3.8.1",
+    "@docusaurus/utils-validation": "3.8.1",
     "fs-extra": "^11.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.7.0",
-    "@docusaurus/types": "3.7.0"
+    "@docusaurus/module-type-aliases": "3.8.1",
+    "@docusaurus/types": "3.8.1"
   }
 }
diff --git a/packages/plugin-docsmenu/package.json b/packages/plugin-docsmenu/package.json
@@ -30,11 +30,11 @@
     "watch": "tsc --build --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "3.7.0",
-    "@docusaurus/plugin-content-docs": "3.7.0"
+    "@docusaurus/core": "3.8.1",
+    "@docusaurus/plugin-content-docs": "3.8.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.7.0",
-    "@docusaurus/types": "3.7.0"
+    "@docusaurus/module-type-aliases": "3.8.1",
+    "@docusaurus/types": "3.8.1"
   }
 }
diff --git a/packages/plugin-getsidebar/package.json b/packages/plugin-getsidebar/package.json
@@ -30,11 +30,11 @@
     "build": "tsc --build"
   },
   "dependencies": {
-    "@docusaurus/core": "3.7.0",
-    "@docusaurus/plugin-content-docs": "3.7.0"
+    "@docusaurus/core": "3.8.1",
+    "@docusaurus/plugin-content-docs": "3.8.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.7.0",
-    "@docusaurus/types": "3.7.0"
+    "@docusaurus/module-type-aliases": "3.8.1",
+    "@docusaurus/types": "3.8.1"
   }
 }
diff --git a/packages/preset-nonepress/package.json b/packages/preset-nonepress/package.json
@@ -18,18 +18,18 @@
     "watch": "tsc --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "3.7.0",
-    "@docusaurus/plugin-content-docs": "3.7.0",
-    "@docusaurus/plugin-content-pages": "3.7.0",
-    "@docusaurus/plugin-debug": "3.7.0",
-    "@docusaurus/plugin-google-analytics": "3.7.0",
-    "@docusaurus/plugin-google-gtag": "3.7.0",
-    "@docusaurus/plugin-google-tag-manager": "3.7.0",
-    "@docusaurus/plugin-ideal-image": "3.7.0",
-    "@docusaurus/plugin-sitemap": "3.7.0",
-    "@docusaurus/theme-common": "3.7.0",
-    "@docusaurus/theme-search-algolia": "3.7.0",
-    "@docusaurus/types": "3.7.0",
+    "@docusaurus/core": "3.8.1",
+    "@docusaurus/plugin-content-docs": "3.8.1",
+    "@docusaurus/plugin-content-pages": "3.8.1",
+    "@docusaurus/plugin-debug": "3.8.1",
+    "@docusaurus/plugin-google-analytics": "3.8.1",
+    "@docusaurus/plugin-google-gtag": "3.8.1",
+    "@docusaurus/plugin-google-tag-manager": "3.8.1",
+    "@docusaurus/plugin-ideal-image": "3.8.1",
+    "@docusaurus/plugin-sitemap": "3.8.1",
+    "@docusaurus/theme-common": "3.8.1",
+    "@docusaurus/theme-search-algolia": "3.8.1",
+    "@docusaurus/types": "3.8.1",
     "@nullbot/docusaurus-theme-nonepress": "^3.4.3"
   },
   "peerDependencies": {
diff --git a/packages/theme-nonepress/package.json b/packages/theme-nonepress/package.json
@@ -37,17 +37,17 @@
   },
   "dependencies": {
     "@docsearch/react": "^3.8.1",
-    "@docusaurus/core": "3.7.0",
-    "@docusaurus/mdx-loader": "3.7.0",
-    "@docusaurus/module-type-aliases": "3.7.0",
-    "@docusaurus/plugin-content-docs": "3.7.0",
-    "@docusaurus/plugin-content-pages": "3.7.0",
-    "@docusaurus/theme-common": "3.7.0",
-    "@docusaurus/theme-translations": "3.7.0",
-    "@docusaurus/types": "3.7.0",
-    "@docusaurus/utils": "3.7.0",
-    "@docusaurus/utils-common": "3.7.0",
-    "@docusaurus/utils-validation": "3.7.0",
+    "@docusaurus/core": "3.8.1",
+    "@docusaurus/mdx-loader": "3.8.1",
+    "@docusaurus/module-type-aliases": "3.8.1",
+    "@docusaurus/plugin-content-docs": "3.8.1",
+    "@docusaurus/plugin-content-pages": "3.8.1",
+    "@docusaurus/theme-common": "3.8.1",
+    "@docusaurus/theme-translations": "3.8.1",
+    "@docusaurus/types": "3.8.1",
+    "@docusaurus/utils": "3.8.1",
+    "@docusaurus/utils-common": "3.8.1",
+    "@docusaurus/utils-validation": "3.8.1",
     "@fortawesome/fontawesome-svg-core": "^6.4.0",
     "@fortawesome/free-brands-svg-icons": "^6.4.0",
     "@fortawesome/free-regular-svg-icons": "^6.4.0",
diff --git a/packages/theme-nonepress/src/theme/DocItem/Footer/index.tsx b/packages/theme-nonepress/src/theme/DocItem/Footer/index.tsx
@@ -73,8 +73,8 @@ export default function DocItemFooter(): ReactNode | null {
       {canDisplayEditMetaRow && (
         <EditMetaRow
           editUrl={editUrl}
-          lastUpdatedAt={lastUpdatedAt}
-          lastUpdatedBy={lastUpdatedBy}
+          lastUpdatedAt={lastUpdatedAt!}
+          lastUpdatedBy={lastUpdatedBy!}
         />
       )}
     </footer>
diff --git a/packages/theme-nonepress/src/theme/SearchPage/index.tsx b/packages/theme-nonepress/src/theme/SearchPage/index.tsx
@@ -12,6 +12,7 @@ import Link from "@docusaurus/Link";
 import { useAllDocsData } from "@docusaurus/plugin-content-docs/client";
 import {
   HtmlClassNameProvider,
+  PageMetadata,
   useEvent,
   usePluralForm,
   useSearchQueryString,
@@ -148,6 +149,26 @@ type ResultDispatcher =
   | { type: "update"; value: ResultDispatcherState }
   | { type: "advance"; value?: undefined };
 
+
+function getSearchPageTitle(searchQuery: string | undefined): string {
+  return searchQuery
+    ? translate(
+        {
+          id: 'theme.SearchPage.existingResultsTitle',
+          message: 'Search results for "{query}"',
+          description: 'The search page title for non-empty query',
+        },
+        {
+          query: searchQuery,
+        },
+      )
+    : translate({
+        id: 'theme.SearchPage.emptyResultsTitle',
+        message: 'Search the documentation',
+        description: 'The search page title for empty query',
+      });
+}
+
 function SearchPageContent(): ReactNode {
   const {
     i18n: { currentLocale },
@@ -161,6 +182,8 @@ function SearchPageContent(): ReactNode {
 
   const docsSearchVersionsHelpers = useDocsSearchVersionsHelpers();
   const [searchQuery, setSearchQuery] = useSearchQueryString();
+  const pageTitle = getSearchPageTitle(searchQuery);
+
   const initialSearchResultState: ResultDispatcherState = {
     items: [],
     query: null,
@@ -295,25 +318,6 @@ function SearchPageContent(): ReactNode {
         { threshold: 1 },
       ),
   );
-
-  const getTitle = () =>
-    searchQuery
-      ? translate(
-          {
-            id: "theme.SearchPage.existingResultsTitle",
-            message: 'Search results for "{query}"',
-            description: "The search page title for non-empty query",
-          },
-          {
-            query: searchQuery,
-          },
-        )
-      : translate({
-          id: "theme.SearchPage.emptyResultsTitle",
-          message: "Search the documentation",
-          description: "The search page title for empty query",
-        });
-
   const makeSearch = useEvent((page: number = 0) => {
     if (contextualSearch) {
       algoliaHelper.addDisjunctiveFacetRefinement("docusaurus_tag", "default");
@@ -366,8 +370,8 @@ function SearchPageContent(): ReactNode {
 
   return (
     <Layout>
+      <PageMetadata title={pageTitle} />
       <Head>
-        <title>{useTitleFormatter(getTitle())}</title>
         {/*
          We should not index search pages
           See https://github.com/facebook/docusaurus/pull/3233
@@ -376,7 +380,7 @@ function SearchPageContent(): ReactNode {
       </Head>
 
       <main className="doc-search-page prose">
-        <Heading as="h1">{getTitle()}</Heading>
+        <Heading as="h1">{pageTitle}</Heading>
 
         <form
           className="join doc-search-page-form"
diff --git a/packages/theme-nonepress/src/theme/ThemeProvider/TitleFormatter/index.tsx b/packages/theme-nonepress/src/theme/ThemeProvider/TitleFormatter/index.tsx
@@ -0,0 +1,20 @@
+import React, {type ComponentProps, type ReactNode} from 'react';
+import {TitleFormatterProvider} from '@docusaurus/theme-common/internal';
+import type {Props} from '@theme/ThemeProvider/TitleFormatter';
+
+type FormatterProp = ComponentProps<typeof TitleFormatterProvider>['formatter'];
+
+const formatter: FormatterProp = (params) => {
+  // Add your own title formatting logic here!
+  return params.defaultFormatter(params);
+};
+
+export default function ThemeProviderTitleFormatter({
+  children,
+}: Props): ReactNode {
+  return (
+    <TitleFormatterProvider formatter={formatter}>
+      {children}
+    </TitleFormatterProvider>
+  );
+}
diff --git a/packages/theme-nonepress/src/theme/ThemeProvider/index.tsx b/packages/theme-nonepress/src/theme/ThemeProvider/index.tsx
@@ -0,0 +1,7 @@
+import React, { type ReactNode } from "react";
+import TitleFormatterProvider from "@theme/ThemeProvider/TitleFormatter";
+import type { Props } from "@theme/ThemeProvider";
+
+export default function ThemeProvider({ children }: Props): ReactNode {
+  return <TitleFormatterProvider>{children}</TitleFormatterProvider>;
+}
diff --git a/packages/theme-nonepress/src/types.d.ts b/packages/theme-nonepress/src/types.d.ts
@@ -1769,6 +1769,17 @@ declare module "@theme/ThemedImage" {
   export default function ThemedImage(props: Props): ReactNode;
 }
 
+declare module '@theme/ThemeProvider/TitleFormatter' {
+  import type {ReactNode} from 'react';
+
+  export interface Props {
+    readonly children: ReactNode;
+  }
+  export default function ThemeProviderTitleFormatter({
+    children,
+  }: Props): ReactNode;
+}
+
 declare module "@theme/TOCItems" {
   import { type ReactNode } from "react";
   import type { TOCItem } from "@docusaurus/mdx-loader";
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -18,6 +18,7 @@ export default async function createConfigAsync() {
 
     future: {
       experimental_faster: true,
+      v4: true,
     },
 
     // Set the /<baseUrl>/ pathname under which your site is served
diff --git a/website/package.json b/website/package.json
@@ -19,16 +19,16 @@
     "prettier": "prettier --config ../.prettierrc --write ."
   },
   "dependencies": {
-    "@docusaurus/core": "3.7.0",
-    "@docusaurus/plugin-ideal-image": "3.7.0",
+    "@docusaurus/core": "3.8.1",
+    "@docusaurus/plugin-ideal-image": "3.8.1",
     "@nullbot/docusaurus-preset-nonepress": "^3.0.0",
     "clsx": "^2.0.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@docusaurus/eslint-plugin": "3.7.0",
-    "@docusaurus/faster": "3.7.0",
+    "@docusaurus/eslint-plugin": "3.8.1",
+    "@docusaurus/faster": "3.8.1",
     "@nullbot/docusaurus-tsconfig": "^3.0.0",
     "cross-env": "^7.0.3",
     "rimraf": "^3.0.2",
diff --git a/yarn.lock b/yarn.lock
