@rspress/shared 1.5.0 → 1.6.0

package/dist/index.d.ts

@@ -65,9 +65,11 @@ interface Config$1 {
      */
     outline?: boolean;
     /**
-     * The nav items.
+     * The nav items. When it's an object, the key is the version of current doc.
      */
-    nav?: NavItem[];
+    nav?: NavItem[] | {
+        [key: string]: NavItem[];
+    };
     /**
      * The sidebar items.
      */
@@ -141,7 +143,7 @@ interface LocaleConfig {
     /**
      * Theme i18n config
      */
-    nav?: NavItem[];
+    nav?: Nav;
     sidebar?: Sidebar;
     outlineTitle?: string;
     lastUpdatedText?: string;
@@ -151,6 +153,9 @@ interface LocaleConfig {
     nextPageText?: string;
     langRoutePrefix?: string;
 }
+type Nav = NavItem[] | {
+    [key: string]: NavItem[];
+};
 type NavItem = NavItemWithLink | NavItemWithChildren | NavItemWithLinkAndChildren;
 type NavItemWithLink = {
     text: string;
@@ -162,13 +167,13 @@ type NavItemWithLink = {
 interface NavItemWithChildren {
     text?: string;
     tag?: string;
-    items: NavItem[];
+    items: NavItemWithLink[];
     position?: 'left' | 'right';
 }
 interface NavItemWithLinkAndChildren {
     text: string;
     link: string;
-    items: NavItem[];
+    items: NavItemWithLink[];
     tag?: string;
     activeMatch?: string;
     position?: 'left' | 'right';
@@ -178,13 +183,13 @@ type Image = string | {
     alt?: string;
 };
 interface Sidebar {
-    [path: string]: (SidebarGroup | SidebarItem)[];
+    [path: string]: (SidebarGroup | SidebarItem | SidebarDivider)[];
 }
 interface SidebarGroup {
     text: string;
     link?: string;
     tag?: string;
-    items: (SidebarItem | SidebarGroup | string)[];
+    items: (SidebarItem | SidebarDivider | SidebarGroup | string)[];
     collapsible?: boolean;
     collapsed?: boolean;
 }
@@ -193,6 +198,9 @@ type SidebarItem = {
     link: string;
     tag?: string;
 };
+type SidebarDivider = {
+    dividerType: 'dashed' | 'solid';
+};
 interface EditLink {
     /**
      * Custom repository url for edit link.
@@ -235,12 +243,12 @@ interface LocaleLink {
     link: string;
 }
 interface NormalizedSidebarGroup extends Omit<SidebarGroup, 'items'> {
-    items: (SidebarItem | NormalizedSidebarGroup)[];
+    items: (SidebarDivider | SidebarItem | NormalizedSidebarGroup)[];
     collapsible: boolean;
     collapsed: boolean;
 }
 interface NormalizedSidebar {
-    [path: string]: (NormalizedSidebarGroup | SidebarItem)[];
+    [path: string]: (NormalizedSidebarGroup | SidebarItem | SidebarDivider)[];
 }
 interface NormalizedLocales extends Omit<LocaleConfig, 'sidebar'> {
     sidebar: NormalizedSidebar;
@@ -664,10 +672,12 @@ declare const isProduction: () => boolean;
 declare const isDebugMode: () => boolean;
 declare const cleanUrl: (url: string) => string;
 declare function slash(str: string): string;
+declare function removeHash(str: string): string;
 declare function normalizePosixPath(id: string): string;
 declare const inBrowser: () => boolean;
 declare function addLeadingSlash(url: string): string;
 declare function removeLeadingSlash(url: string): string;
+declare function addTrailingSlash(url: string): string;
 declare function removeTrailingSlash(url: string): string;
 declare function normalizeSlash(url: string): string;
 declare function isExternalUrl(url: string): boolean;
@@ -699,4 +709,4 @@ declare function removeBase(url: string, base: string): string;
 declare function withoutHash(url: string): string;
 declare const mergeDocConfig: (...configs: UserConfig[]) => UserConfig;
 
-export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, NavItem, NavItemWithChildren, NavItemWithLink, NavItemWithLinkAndChildren, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, RemotePageInfo, RemoteSearchIndexInfo, RemoteSearchOptions, ReplaceRule, Route, RouteMeta, RouteOptions, RspressPlugin, SEARCH_INDEX_NAME, SearchHooks, SearchOptions, Sidebar, SidebarGroup, SidebarItem, SiteData, SocialLink, SocialLinkIcon, UserConfig, addLeadingSlash, cleanUrl, inBrowser, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };
+export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, Nav, NavItem, NavItemWithChildren, NavItemWithLink, NavItemWithLinkAndChildren, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, RemotePageInfo, RemoteSearchIndexInfo, RemoteSearchOptions, ReplaceRule, Route, RouteMeta, RouteOptions, RspressPlugin, SEARCH_INDEX_NAME, SearchHooks, SearchOptions, Sidebar, SidebarDivider, SidebarGroup, SidebarItem, SiteData, SocialLink, SocialLinkIcon, UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };

package/dist/index.js

@@ -27,6 +27,7 @@ __export(src_exports, {
   RSPRESS_TEMP_DIR: () => RSPRESS_TEMP_DIR,
   SEARCH_INDEX_NAME: () => SEARCH_INDEX_NAME,
   addLeadingSlash: () => addLeadingSlash,
+  addTrailingSlash: () => addTrailingSlash,
   cleanUrl: () => cleanUrl,
   inBrowser: () => inBrowser,
   isDebugMode: () => isDebugMode,
@@ -40,6 +41,7 @@ __export(src_exports, {
   omit: () => omit,
   parseUrl: () => parseUrl,
   removeBase: () => removeBase,
+  removeHash: () => removeHash,
   removeLeadingSlash: () => removeLeadingSlash,
   removeTrailingSlash: () => removeTrailingSlash,
   replaceLang: () => replaceLang,
@@ -1121,6 +1123,9 @@ var cleanUrl = (url) => url.replace(HASH_REGEXP, "").replace(QUERY_REGEXP, "");
 function slash(str) {
   return str.replace(/\\/g, "/");
 }
+function removeHash(str) {
+  return str.replace(/#.*$/, "");
+}
 function normalizePosixPath(id) {
   const path = slash(id);
   const isAbsolutePath = path.startsWith("/");
@@ -1152,6 +1157,9 @@ function addLeadingSlash(url) {
 function removeLeadingSlash(url) {
   return url.charAt(0) === "/" ? url.slice(1) : url;
 }
+function addTrailingSlash(url) {
+  return url.charAt(url.length - 1) === "/" ? url : `${url}/`;
+}
 function removeTrailingSlash(url) {
   return url.charAt(url.length - 1) === "/" ? url.slice(0, -1) : url;
 }
@@ -1290,6 +1298,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   RSPRESS_TEMP_DIR,
   SEARCH_INDEX_NAME,
   addLeadingSlash,
+  addTrailingSlash,
   cleanUrl,
   inBrowser,
   isDebugMode,
@@ -1303,6 +1312,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   omit,
   parseUrl,
   removeBase,
+  removeHash,
   removeLeadingSlash,
   removeTrailingSlash,
   replaceLang,

package/dist/index.mjs

@@ -1067,6 +1067,9 @@ var cleanUrl = (url) => url.replace(HASH_REGEXP, "").replace(QUERY_REGEXP, "");
 function slash(str) {
   return str.replace(/\\/g, "/");
 }
+function removeHash(str) {
+  return str.replace(/#.*$/, "");
+}
 function normalizePosixPath(id) {
   const path = slash(id);
   const isAbsolutePath = path.startsWith("/");
@@ -1098,6 +1101,9 @@ function addLeadingSlash(url) {
 function removeLeadingSlash(url) {
   return url.charAt(0) === "/" ? url.slice(1) : url;
 }
+function addTrailingSlash(url) {
+  return url.charAt(url.length - 1) === "/" ? url : `${url}/`;
+}
 function removeTrailingSlash(url) {
   return url.charAt(url.length - 1) === "/" ? url.slice(0, -1) : url;
 }
@@ -1235,6 +1241,7 @@ export {
   RSPRESS_TEMP_DIR,
   SEARCH_INDEX_NAME,
   addLeadingSlash,
+  addTrailingSlash,
   cleanUrl,
   inBrowser,
   isDebugMode,
@@ -1248,6 +1255,7 @@ export {
   omit,
   parseUrl,
   removeBase,
+  removeHash,
   removeLeadingSlash,
   removeTrailingSlash,
   replaceLang,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -22,7 +22,7 @@
     }
   },
   "dependencies": {
-    "@rsbuild/core": "0.0.13",
+    "@rsbuild/core": "0.0.14",
     "unified": "10.1.2",
     "chalk": "4.1.2",
     "rslog": "^1.1.0"