fix: withbase routepath

web-infra-dev · Apr 7, 2024 · f719ce6 · f719ce6
1 parent 21d9c70
commit f719ce6
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/packages/document/docs/en/fragments/internal-components.mdx b/packages/document/docs/en/fragments/internal-components.mdx
@@ -145,7 +145,10 @@ export interface OverviewProps {
   content?: React.ReactNode;
   // data
   groups?: Group[];
+  // default title
   defaultGroupTitle?: string;
+  // minimum title displayed in the overview page of the file
+  overviewDepth?: 'h1' | 'h2';
 }
 ```
 

diff --git a/packages/document/docs/zh/fragments/internal-components.mdx b/packages/document/docs/zh/fragments/internal-components.mdx
@@ -148,6 +148,8 @@ export interface OverviewProps {
   groups?: Group[];
   // 默认标题
   defaultGroupTitle?: string;
+  // 在预览页中展示的最小标题
+  overviewDepth?: 'h1' | 'h2';
 }
 ```
 

diff --git a/packages/theme-default/src/components/Overview/index.tsx b/packages/theme-default/src/components/Overview/index.tsx
@@ -4,6 +4,7 @@ import {
   NormalizedSidebarGroup,
   SidebarItem,
   SidebarDivider,
+  type OverViewDepth,
 } from '@rspress/shared';
 import {
   usePageData,
@@ -34,6 +35,7 @@ export function Overview(props: {
   content?: React.ReactNode;
   groups?: Group[];
   defaultGroupTitle?: string;
+  overviewDepth?: OverViewDepth;
 }) {
   const {
     siteData,
@@ -58,7 +60,7 @@ export function Overview(props: {
   };
   const findItemByRoutePath = (items, routePath, originalItems) => {
     for (const item of items) {
-      if (item.link === routePath) {
+      if (withBase(item.link) === routePath) {
         return [item];
       }
       if (item.items) {
@@ -94,11 +96,17 @@ export function Overview(props: {
       return item;
     }
     // do not display overview title in sub pages overview
-    if (item.link === `${routePath}index` && frontmatter?.overview === true) {
+    if (
+      withBase(item.link) === `${routePath}index` &&
+      frontmatter?.overview === true
+    ) {
       return false;
     }
     const overviewDepth =
-      item.overviewDepth ?? sidebarGroup?.overviewDepth ?? 'h2';
+      props?.overviewDepth ??
+      item.overviewDepth ??
+      sidebarGroup?.overviewDepth ??
+      'h2';
     const headerDepth = Number(overviewDepth.replace('h', ''));
     // sidebar items link without base path
     const pageModule = overviewModules.find(m =>