@rspress/shared 0.0.0-next-20240319081819 → 0.0.0-next-20240407073144

package/dist/index.d.ts

@@ -140,6 +140,11 @@ interface Config$1 {
      * @default false
      */
     enableScrollToTop?: boolean;
+    /**
+     * Whether to redirect to the closest locale when the user visits the site
+     * @default 'auto'
+     */
+    localeRedirect?: 'auto' | 'never';
 }
 /**
  * locale config
@@ -196,6 +201,7 @@ type Image = string | {
     src: string;
     alt?: string;
 };
+type OverViewDepth = 'h1' | 'h2';
 interface Sidebar {
     [path: string]: (SidebarGroup | SidebarItem | SidebarDivider | SidebarSectionHeader)[];
 }
@@ -210,6 +216,7 @@ interface SidebarGroup {
      * For hmr usage in development
      */
     _fileKey?: string;
+    overviewDepth?: OverViewDepth;
 }
 type SidebarItem = {
     text: string;
@@ -219,6 +226,7 @@ type SidebarItem = {
      * For hmr usage in development
      */
     _fileKey?: string;
+    overviewDepth?: OverViewDepth;
 };
 type SidebarDivider = {
     dividerType: 'dashed' | 'solid';
@@ -410,6 +418,10 @@ interface UserConfig<ThemeConfig = Config$1> {
         dark: string;
         light: string;
     };
+    /**
+     * The text of the logo in nav bar.
+     */
+    logoText?: string;
     /**
      * Base path of the site.
      */
@@ -533,6 +545,7 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
         dark: string;
         light: string;
     };
+    logoText: string;
     pages: BaseRuntimePageInfo[];
     search: SearchOptions;
     ssg: boolean;
@@ -748,4 +761,4 @@ declare function removeBase(url: string, base: string): string;
 declare function withoutHash(url: string): string;
 declare const mergeDocConfig: (...configs: UserConfig[]) => UserConfig;
 
-export { APPEARANCE_KEY, type AdditionalPage, type BaseRuntimePageInfo, type Config, DEFAULT_HIGHLIGHT_LANGUAGES, type Config$1 as DefaultThemeConfig, type DocFooter, type EditLink, type Feature, type Footer, type FrontMatterMeta, HASH_REGEXP, type Header, type Hero, type Image, type LocalSearchOptions, type Locale, type LocaleConfig, type LocaleLink, type LocaleLinks, MDX_REGEXP, type MarkdownOptions, type MdxRsOptions, type Nav, type NavItem, type NavItemWithChildren, type NavItemWithLink, type NavItemWithLinkAndChildren, type NormalizedConfig, type NormalizedConfig as NormalizedDefaultThemeConfig, type NormalizedLocales, type NormalizedSidebar, type NormalizedSidebarGroup, type PageData, type PageIndexInfo, type PageModule, type PageType, type RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, type RemotePageInfo, type RemoteSearchIndexInfo, type RemoteSearchOptions, type ReplaceRule, type Route, type RouteMeta, type RouteOptions, type RspressPlugin, SEARCH_INDEX_NAME, type SearchHooks, type SearchOptions, type Sidebar, type SidebarDivider, type SidebarGroup, type SidebarItem, type SidebarSectionHeader, type SiteData, type SocialLink, type SocialLinkIcon, type UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDataUrl, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };
+export { APPEARANCE_KEY, type AdditionalPage, type BaseRuntimePageInfo, type Config, DEFAULT_HIGHLIGHT_LANGUAGES, type Config$1 as DefaultThemeConfig, type DocFooter, type EditLink, type Feature, type Footer, type FrontMatterMeta, HASH_REGEXP, type Header, type Hero, type Image, type LocalSearchOptions, type Locale, type LocaleConfig, type LocaleLink, type LocaleLinks, MDX_REGEXP, type MarkdownOptions, type MdxRsOptions, type Nav, type NavItem, type NavItemWithChildren, type NavItemWithLink, type NavItemWithLinkAndChildren, type NormalizedConfig, type NormalizedConfig as NormalizedDefaultThemeConfig, type NormalizedLocales, type NormalizedSidebar, type NormalizedSidebarGroup, type OverViewDepth, type PageData, type PageIndexInfo, type PageModule, type PageType, type RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, type RemotePageInfo, type RemoteSearchIndexInfo, type RemoteSearchOptions, type ReplaceRule, type Route, type RouteMeta, type RouteOptions, type RspressPlugin, SEARCH_INDEX_NAME, type SearchHooks, type SearchOptions, type Sidebar, type SidebarDivider, type SidebarGroup, type SidebarItem, type SidebarSectionHeader, type SiteData, type SocialLink, type SocialLinkIcon, type UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDataUrl, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "0.0.0-next-20240319081819",
+  "version": "0.0.0-next-20240407073144",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -42,7 +42,7 @@
     }
   },
   "dependencies": {
-    "@rsbuild/core": "0.4.15",
+    "@rsbuild/core": "0.5.1",
     "unified": "10.1.2",
     "chalk": "4.1.2",
     "execa": "5.1.1",