@rspress/shared 2.0.13 → 2.0.15

package/dist/index.d.ts

@@ -27,6 +27,8 @@ export declare const cleanUrl: (url: string) => string;
 
 export declare type Config = UserConfig | Promise<UserConfig> | ((...args: Parameters<typeof loadConfig>) => UserConfig | Promise<UserConfig>);
 
+export declare type DarkMode = boolean | NormalizedDarkMode;
+
 export declare interface EditLink {
     /**
      * Custom repository url for edit link.
@@ -85,9 +87,12 @@ export declare interface FrontMatterMeta {
     titleSuffix?: string;
     head?: [string, Record<string, string>][];
     context?: string;
+    search?: boolean;
     [key: string]: unknown;
 }
 
+export declare const getDefaultDarkModeValue: (darkMode: DarkMode | undefined) => ThemeConfigValue;
+
 /**
  * get the sidebar group for the current page
  * @param sidebar const { sidebar } = useLocaleSiteData();
@@ -144,6 +149,7 @@ export declare interface I18nText {
     outlineTitle?: I18nTextValue;
     scrollToTopText?: I18nTextValue;
     lastUpdatedText?: I18nTextValue;
+    lastUpdatedAuthorText?: I18nTextValue;
     prevPageText?: I18nTextValue;
     nextPageText?: I18nTextValue;
     editLinkText?: I18nTextValue;
@@ -173,6 +179,8 @@ declare type I18nTextValue = {
 
 export declare const inBrowser: () => boolean;
 
+export declare const isDarkModeSwitchEnabled: (darkMode: DarkMode | undefined) => boolean;
+
 export declare function isDataUrl(url?: string): boolean;
 
 export declare const isDebugMode: () => boolean;
@@ -183,6 +191,23 @@ export declare function isExternalUrl(url?: string): boolean;
 
 export declare const isProduction: () => boolean;
 
+export declare type LastUpdated = boolean | {
+    /**
+     * Whether to display the last author of the file (from git log).
+     * - `false`: hide the author.
+     * - `true`: show the commit author's name.
+     * - function: receives `{ name, email, filePath }` and returns the display string.
+     * @default false
+     */
+    author?: LastUpdatedAuthor;
+};
+
+export declare type LastUpdatedAuthor = boolean | ((info: {
+    name: string;
+    email: string;
+    filePath: string;
+}) => string);
+
 /**
  * Configuration for LLMS UI components displayed on H1 headers.
  * When enabled, LlmsCopyButton and LlmsViewOptions will be automatically
@@ -257,10 +282,25 @@ export declare type LocalSearchOptions = SearchHooks & {
 };
 
 export declare interface MarkdownOptions {
+    /**
+     * @default []
+     */
     remarkPlugins?: PluggableList;
+    /**
+     * @default []
+     */
     rehypePlugins?: PluggableList;
+    /**
+     * @default { checkDeadLinks: true, checkAnchors: false, autoPrefix: true }
+     */
     link?: RemarkLinkOptions;
+    /**
+     * @default { checkDeadImages: true }
+     */
     image?: RemarkImageOptions;
+    /**
+     * @default false
+     */
     showLineNumbers?: boolean;
     /**
      * Whether to wrap code by default
@@ -285,6 +325,7 @@ export declare interface MarkdownOptions {
     };
     /**
      * Register global components in mdx files
+     * @default []
      */
     globalComponents?: string[];
     /**
@@ -358,6 +399,14 @@ export declare interface NavItemWithLinkAndChildren {
     rel?: string;
 }
 
+export declare const normalizeDarkMode: (darkMode: DarkMode | undefined) => NormalizedDarkMode;
+
+export declare type NormalizedDarkMode = 'light' | 'dark' | 'auto' | 'force-light' | 'force-dark' | 'force-auto';
+
+export declare type NormalizedLastUpdated = boolean | {
+    author?: boolean;
+};
+
 export declare interface NormalizedLocales extends Omit<LocaleConfig, 'sidebar'> {
     sidebar: NormalizedSidebar;
 }
@@ -372,7 +421,8 @@ export declare interface NormalizedSidebarGroup extends Omit<SidebarGroup, 'item
     collapsed: boolean;
 }
 
-declare interface NormalizedThemeConfig extends Omit<ThemeConfig, 'locales' | 'sidebar'> {
+declare interface NormalizedThemeConfig extends Omit<ThemeConfig, 'lastUpdated' | 'locales' | 'sidebar'> {
+    lastUpdated?: NormalizedLastUpdated;
     locales: NormalizedLocales[];
     sidebar: NormalizedSidebar;
 }
@@ -395,6 +445,7 @@ export declare interface PageDataLegacy {
         headingTitle?: string;
         pagePath: string;
         lastUpdatedTime?: string;
+        lastUpdatedAuthor?: string;
         description?: string;
         pageType: PageType;
         [key: string]: unknown;
@@ -455,6 +506,13 @@ export declare type RemarkLinkOptions = {
     checkDeadLinks?: boolean | {
         excludes: string[] | ((url: string) => boolean);
     };
+    /**
+     * Whether to enable dead anchor checks
+     * @default false
+     */
+    checkAnchors?: boolean | {
+        excludes: string[] | ((url: string) => boolean);
+    };
     /**
      * [](/v3/zh/guide) [](/zh/guide) [](/guide) will be regarded as the same [](/v3/zh/guide) according to the directory.
      * @default true
@@ -548,7 +606,7 @@ export declare interface RouteMeta {
 export declare interface RouteOptions {
     /**
      * The extension name of the filepath that will be converted to a route
-     * @default ['js','jsx','ts','tsx','md','mdx']
+     * @default ['.js', '.jsx', '.ts', '.tsx', '.md', '.mdx']
      */
     extensions?: string[];
     /**
@@ -736,7 +794,14 @@ export declare function slash(str: string): string;
 
 export declare interface SocialLink {
     icon: SocialLinkIcon;
-    mode: 'link' | 'text' | 'img' | 'dom';
+    mode: 'link' | 'text' | 'img' | 'dom' | 'github-stars';
+    /**
+     * For most modes, the URL, text, image path, or raw HTML to render.
+     *
+     * For `github-stars` mode, the GitHub repository URL
+     * (e.g. `https://github.com/web-infra-dev/rspress`). The repository's star
+     * count is fetched from the GitHub API and rendered next to the icon.
+     */
     content: string;
 }
 
@@ -746,12 +811,15 @@ declare type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'inst
 
 declare type ThemeConfig = {
     /**
-     * Whether to enable dark mode.
+     * Whether to enable dark mode and how to resolve the default theme.
+     * - `true`: same as `'auto'`.
+     * - `false`: same as `'force-light'`.
      * @default true
      */
-    darkMode?: boolean;
+    darkMode?: DarkMode;
     /**
      * The nav items. When it's an object, the key is the version of current doc.
+     * @default []
      */
     nav?: NavItem[] | {
         [key: string]: NavItem[];
@@ -767,12 +835,14 @@ declare type ThemeConfig = {
     editLink?: EditLink;
     /**
      * Whether to display the last update time of the file.
+     * Set `author` to show the last commit author.
      * @default false
      */
-    lastUpdated?: boolean;
+    lastUpdated?: LastUpdated;
     /**
      * The social links to be displayed at the end of the nav bar. Perfect for
      * placing links to social services such as GitHub, X, Facebook, etc.
+     * @default []
      */
     socialLinks?: SocialLink[];
     /**
@@ -790,7 +860,7 @@ declare type ThemeConfig = {
     /**
      * The behavior of hiding navbar
      * Currently, Rspress V2 does not implement `hideNavBar`
-     * @default 'never''
+     * @default 'never'
      */
     hideNavbar?: 'always' | 'auto' | 'never';
     /**
@@ -829,6 +899,8 @@ declare type ThemeConfig = {
 export { ThemeConfig as DefaultThemeConfig }
 export { ThemeConfig }
 
+declare type ThemeConfigValue = 'light' | 'dark' | 'auto';
+
 export declare interface UserConfig {
     /**
      * The root directory of the site.
@@ -837,6 +909,7 @@ export declare interface UserConfig {
     root?: string;
     /**
      * Path to the logo file in nav bar.
+     * @default ''
      */
     logo?: string | {
         dark: string;
@@ -859,6 +932,7 @@ export declare interface UserConfig {
     base?: string;
     /**
      * Path to html icon file.
+     * @default ''
      */
     icon?: string | URL;
     /**
@@ -886,11 +960,12 @@ export declare interface UserConfig {
     locales?: Locale[];
     /**
      * The i18n text data source path. Default is `i18n.json` in cwd.
-     * @default '<cwd>/i18n.json'
+     * @default path.join(process.cwd(), 'i18n.json')
      */
     i18nSourcePath?: string;
     /**
      * The i18n text data.
+     * @default {}
      */
     i18nSource?: (I18nText & Record<string, Record<string, string>>) | ((value: Record<string, Record<string, string>>) => Record<string, Record<string, string>> | Promise<Record<string, Record<string, string>>>);
     /**
@@ -915,18 +990,22 @@ export declare interface UserConfig {
     plugins?: RspressPlugin[];
     /**
      * Replace rule, will replace the content of the page.
+     * @default []
      */
     replaceRules?: ReplaceRule[];
     /**
      * Output directory
+     * @default 'doc_build'
      */
     outDir?: string;
     /**
      * User side custom theme directory
+     * @default path.join(process.cwd(), 'theme')
      */
     themeDir?: string;
     /**
      * Global components
+     * @default []
      */
     globalUIComponents?: (string | [string, object])[];
     /**
@@ -991,14 +1070,17 @@ export declare interface UserConfig {
     languageParity?: {
         /**
          * Whether to enable language parity checking
+         * @default false
          */
         enabled?: boolean;
         /**
          * Directories to include in the parity check
+         * @default []
          */
         include?: string[];
         /**
          * Directories to exclude from the parity check
+         * @default []
          */
         exclude?: string[];
     };

package/dist/index.js

@@ -162,4 +162,15 @@ const getSidebarDataGroup = (sidebar, currentPathname)=>{
     return [];
 };
 const matchNavbar = (item, currentPathname)=>new RegExp(item.activeMatch || normalizeHref(item.link, true)).test(currentPathname);
-export { HASH_REGEXP, MDX_OR_MD_REGEXP, QUERY_REGEXP, RSPRESS_TEMP_DIR, SEARCH_INDEX_NAME, addLeadingSlash, addTrailingSlash, getSidebarDataGroup, inBrowser, isDataUrl, isDebugMode, isDevDebugMode, isExternalUrl, isProduction, matchNavbar, matchSidebar, normalizeHref, normalizePosixPath, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, utils_cleanUrl as cleanUrl, withBase, withoutLang };
+const normalizeDarkMode = (darkMode)=>{
+    if (false === darkMode) return 'force-light';
+    if (true === darkMode || void 0 === darkMode) return 'auto';
+    return darkMode;
+};
+const getDefaultDarkModeValue = (darkMode)=>{
+    const normalizedDarkMode = normalizeDarkMode(darkMode);
+    if (normalizedDarkMode.startsWith('force-')) return normalizedDarkMode.slice(6);
+    return normalizedDarkMode;
+};
+const isDarkModeSwitchEnabled = (darkMode)=>!normalizeDarkMode(darkMode).startsWith('force-');
+export { HASH_REGEXP, MDX_OR_MD_REGEXP, QUERY_REGEXP, RSPRESS_TEMP_DIR, SEARCH_INDEX_NAME, addLeadingSlash, addTrailingSlash, getDefaultDarkModeValue, getSidebarDataGroup, inBrowser, isDarkModeSwitchEnabled, isDataUrl, isDebugMode, isDevDebugMode, isExternalUrl, isProduction, matchNavbar, matchSidebar, normalizeDarkMode, normalizeHref, normalizePosixPath, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, utils_cleanUrl as cleanUrl, withBase, withoutLang };

package/dist/node-utils.d.ts

@@ -19,6 +19,8 @@ declare interface AdditionalPage {
     filepath?: string;
 }
 
+declare type DarkMode = boolean | NormalizedDarkMode;
+
 declare interface EditLink {
     /**
      * Custom repository url for edit link.
@@ -82,6 +84,7 @@ declare interface FrontMatterMeta {
     titleSuffix?: string;
     head?: [string, Record<string, string>][];
     context?: string;
+    search?: boolean;
     [key: string]: unknown;
 }
 
@@ -147,6 +150,7 @@ declare interface I18nText {
     outlineTitle?: I18nTextValue;
     scrollToTopText?: I18nTextValue;
     lastUpdatedText?: I18nTextValue;
+    lastUpdatedAuthorText?: I18nTextValue;
     prevPageText?: I18nTextValue;
     nextPageText?: I18nTextValue;
     editLinkText?: I18nTextValue;
@@ -174,6 +178,23 @@ declare type I18nTextValue = {
     [key: string]: string;
 };
 
+declare type LastUpdated = boolean | {
+    /**
+     * Whether to display the last author of the file (from git log).
+     * - `false`: hide the author.
+     * - `true`: show the commit author's name.
+     * - function: receives `{ name, email, filePath }` and returns the display string.
+     * @default false
+     */
+    author?: LastUpdatedAuthor;
+};
+
+declare type LastUpdatedAuthor = boolean | ((info: {
+    name: string;
+    email: string;
+    filePath: string;
+}) => string);
+
 /**
  * Configuration for LLMS UI components displayed on H1 headers.
  * When enabled, LlmsCopyButton and LlmsViewOptions will be automatically
@@ -254,10 +275,25 @@ declare type LocalSearchOptions = SearchHooks & {
 };
 
 declare interface MarkdownOptions {
+    /**
+     * @default []
+     */
     remarkPlugins?: PluggableList;
+    /**
+     * @default []
+     */
     rehypePlugins?: PluggableList;
+    /**
+     * @default { checkDeadLinks: true, checkAnchors: false, autoPrefix: true }
+     */
     link?: RemarkLinkOptions;
+    /**
+     * @default { checkDeadImages: true }
+     */
     image?: RemarkImageOptions;
+    /**
+     * @default false
+     */
     showLineNumbers?: boolean;
     /**
      * Whether to wrap code by default
@@ -282,6 +318,7 @@ declare interface MarkdownOptions {
     };
     /**
      * Register global components in mdx files
+     * @default []
      */
     globalComponents?: string[];
     /**
@@ -346,6 +383,8 @@ declare interface NavItemWithLinkAndChildren {
     rel?: string;
 }
 
+declare type NormalizedDarkMode = 'light' | 'dark' | 'auto' | 'force-light' | 'force-dark' | 'force-auto';
+
 /**
  * @description search-index.json file
  * "_foo" is the private field that won't be written to search-index.json file
@@ -385,6 +424,13 @@ declare type RemarkLinkOptions = {
     checkDeadLinks?: boolean | {
         excludes: string[] | ((url: string) => boolean);
     };
+    /**
+     * Whether to enable dead anchor checks
+     * @default false
+     */
+    checkAnchors?: boolean | {
+        excludes: string[] | ((url: string) => boolean);
+    };
     /**
      * [](/v3/zh/guide) [](/zh/guide) [](/guide) will be regarded as the same [](/v3/zh/guide) according to the directory.
      * @default true
@@ -434,7 +480,7 @@ declare interface RouteMeta {
 declare interface RouteOptions {
     /**
      * The extension name of the filepath that will be converted to a route
-     * @default ['js','jsx','ts','tsx','md','mdx']
+     * @default ['.js', '.jsx', '.ts', '.tsx', '.md', '.mdx']
      */
     extensions?: string[];
     /**
@@ -582,7 +628,14 @@ declare type SidebarSectionHeader = {
 
 declare interface SocialLink {
     icon: SocialLinkIcon;
-    mode: 'link' | 'text' | 'img' | 'dom';
+    mode: 'link' | 'text' | 'img' | 'dom' | 'github-stars';
+    /**
+     * For most modes, the URL, text, image path, or raw HTML to render.
+     *
+     * For `github-stars` mode, the GitHub repository URL
+     * (e.g. `https://github.com/web-infra-dev/rspress`). The repository's star
+     * count is fetched from the GitHub API and rendered next to the icon.
+     */
     content: string;
 }
 
@@ -592,12 +645,15 @@ declare type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'inst
 
 declare type ThemeConfig = {
     /**
-     * Whether to enable dark mode.
+     * Whether to enable dark mode and how to resolve the default theme.
+     * - `true`: same as `'auto'`.
+     * - `false`: same as `'force-light'`.
      * @default true
      */
-    darkMode?: boolean;
+    darkMode?: DarkMode;
     /**
      * The nav items. When it's an object, the key is the version of current doc.
+     * @default []
      */
     nav?: NavItem[] | {
         [key: string]: NavItem[];
@@ -613,12 +669,14 @@ declare type ThemeConfig = {
     editLink?: EditLink;
     /**
      * Whether to display the last update time of the file.
+     * Set `author` to show the last commit author.
      * @default false
      */
-    lastUpdated?: boolean;
+    lastUpdated?: LastUpdated;
     /**
      * The social links to be displayed at the end of the nav bar. Perfect for
      * placing links to social services such as GitHub, X, Facebook, etc.
+     * @default []
      */
     socialLinks?: SocialLink[];
     /**
@@ -636,7 +694,7 @@ declare type ThemeConfig = {
     /**
      * The behavior of hiding navbar
      * Currently, Rspress V2 does not implement `hideNavBar`
-     * @default 'never''
+     * @default 'never'
      */
     hideNavbar?: 'always' | 'auto' | 'never';
     /**
@@ -681,6 +739,7 @@ declare interface UserConfig {
     root?: string;
     /**
      * Path to the logo file in nav bar.
+     * @default ''
      */
     logo?: string | {
         dark: string;
@@ -703,6 +762,7 @@ declare interface UserConfig {
     base?: string;
     /**
      * Path to html icon file.
+     * @default ''
      */
     icon?: string | URL;
     /**
@@ -730,11 +790,12 @@ declare interface UserConfig {
     locales?: Locale[];
     /**
      * The i18n text data source path. Default is `i18n.json` in cwd.
-     * @default '<cwd>/i18n.json'
+     * @default path.join(process.cwd(), 'i18n.json')
      */
     i18nSourcePath?: string;
     /**
      * The i18n text data.
+     * @default {}
      */
     i18nSource?: (I18nText & Record<string, Record<string, string>>) | ((value: Record<string, Record<string, string>>) => Record<string, Record<string, string>> | Promise<Record<string, Record<string, string>>>);
     /**
@@ -759,18 +820,22 @@ declare interface UserConfig {
     plugins?: RspressPlugin[];
     /**
      * Replace rule, will replace the content of the page.
+     * @default []
      */
     replaceRules?: ReplaceRule[];
     /**
      * Output directory
+     * @default 'doc_build'
      */
     outDir?: string;
     /**
      * User side custom theme directory
+     * @default path.join(process.cwd(), 'theme')
      */
     themeDir?: string;
     /**
      * Global components
+     * @default []
      */
     globalUIComponents?: (string | [string, object])[];
     /**
@@ -835,14 +900,17 @@ declare interface UserConfig {
     languageParity?: {
         /**
          * Whether to enable language parity checking
+         * @default false
          */
         enabled?: boolean;
         /**
          * Directories to include in the parity check
+         * @default []
          */
         include?: string[];
         /**
          * Directories to exclude from the parity check
+         * @default []
          */
         exclude?: string[];
     };

package/dist/rslib-runtime.js

@@ -20,11 +20,15 @@ __webpack_require__.m = __webpack_modules__;
     };
 })();
 (()=>{
-    __webpack_require__.d = (exports, definition)=>{
-        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) Object.defineProperty(exports, key, {
-            enumerable: true,
-            get: definition[key]
-        });
+    __webpack_require__.d = (exports, getters, values)=>{
+        var define = (defs, kind)=>{
+            for(var key in defs)if (__webpack_require__.o(defs, key) && !__webpack_require__.o(exports, key)) Object.defineProperty(exports, key, {
+                enumerable: true,
+                [kind]: defs[key]
+            });
+        };
+        define(getters, "get");
+        define(values, "value");
     };
 })();
 (()=>{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "2.0.13",
+  "version": "2.0.15",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/web-infra-dev/rspress.git",
@@ -44,22 +44,22 @@
     "dist"
   ],
   "dependencies": {
-    "@rsbuild/core": "^2.0.7",
-    "@shikijs/rehype": "^4.0.2",
+    "@rsbuild/core": "^2.0.15",
+    "@shikijs/rehype": "^4.2.0",
     "unified": "^11.0.5"
   },
   "devDependencies": {
-    "@rslib/core": "0.21.5",
+    "@rslib/core": "0.23.0",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.8.1",
-    "@types/react": "^19.2.15",
+    "@types/react": "^19.2.17",
     "github-slugger": "^2.0.0",
     "gray-matter": "4.0.3",
     "lodash-es": "^4.18.1",
     "mdast-util-mdx-jsx": "^3.2.0",
     "medium-zoom": "1.1.0",
     "rimraf": "^6.1.3",
-    "rsbuild-plugin-publint": "^0.3.4",
+    "rsbuild-plugin-publint": "^1.0.0",
     "typescript": "^6.0.3"
   },
   "publishConfig": {