@rspress/shared 2.0.13 → 2.0.14

package/dist/index.d.ts

@@ -257,10 +257,25 @@ export declare type LocalSearchOptions = SearchHooks & {
 };
 
 export declare interface MarkdownOptions {
+    /**
+     * @default []
+     */
     remarkPlugins?: PluggableList;
+    /**
+     * @default []
+     */
     rehypePlugins?: PluggableList;
+    /**
+     * @default { checkDeadLinks: true, autoPrefix: true }
+     */
     link?: RemarkLinkOptions;
+    /**
+     * @default { checkDeadImages: true }
+     */
     image?: RemarkImageOptions;
+    /**
+     * @default false
+     */
     showLineNumbers?: boolean;
     /**
      * Whether to wrap code by default
@@ -285,6 +300,7 @@ export declare interface MarkdownOptions {
     };
     /**
      * Register global components in mdx files
+     * @default []
      */
     globalComponents?: string[];
     /**
@@ -548,7 +564,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 +752,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;
 }
 
@@ -752,6 +775,7 @@ declare type ThemeConfig = {
     darkMode?: boolean;
     /**
      * The nav items. When it's an object, the key is the version of current doc.
+     * @default []
      */
     nav?: NavItem[] | {
         [key: string]: NavItem[];
@@ -773,6 +797,7 @@ declare type ThemeConfig = {
     /**
      * 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 +815,7 @@ declare type ThemeConfig = {
     /**
      * The behavior of hiding navbar
      * Currently, Rspress V2 does not implement `hideNavBar`
-     * @default 'never''
+     * @default 'never'
      */
     hideNavbar?: 'always' | 'auto' | 'never';
     /**
@@ -837,6 +862,7 @@ export declare interface UserConfig {
     root?: string;
     /**
      * Path to the logo file in nav bar.
+     * @default ''
      */
     logo?: string | {
         dark: string;
@@ -859,6 +885,7 @@ export declare interface UserConfig {
     base?: string;
     /**
      * Path to html icon file.
+     * @default ''
      */
     icon?: string | URL;
     /**
@@ -886,11 +913,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 +943,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 +1023,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/node-utils.d.ts

@@ -254,10 +254,25 @@ declare type LocalSearchOptions = SearchHooks & {
 };
 
 declare interface MarkdownOptions {
+    /**
+     * @default []
+     */
     remarkPlugins?: PluggableList;
+    /**
+     * @default []
+     */
     rehypePlugins?: PluggableList;
+    /**
+     * @default { checkDeadLinks: true, autoPrefix: true }
+     */
     link?: RemarkLinkOptions;
+    /**
+     * @default { checkDeadImages: true }
+     */
     image?: RemarkImageOptions;
+    /**
+     * @default false
+     */
     showLineNumbers?: boolean;
     /**
      * Whether to wrap code by default
@@ -282,6 +297,7 @@ declare interface MarkdownOptions {
     };
     /**
      * Register global components in mdx files
+     * @default []
      */
     globalComponents?: string[];
     /**
@@ -434,7 +450,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 +598,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;
 }
 
@@ -598,6 +621,7 @@ declare type ThemeConfig = {
     darkMode?: boolean;
     /**
      * The nav items. When it's an object, the key is the version of current doc.
+     * @default []
      */
     nav?: NavItem[] | {
         [key: string]: NavItem[];
@@ -619,6 +643,7 @@ declare type ThemeConfig = {
     /**
      * 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 +661,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 +706,7 @@ declare interface UserConfig {
     root?: string;
     /**
      * Path to the logo file in nav bar.
+     * @default ''
      */
     logo?: string | {
         dark: string;
@@ -703,6 +729,7 @@ declare interface UserConfig {
     base?: string;
     /**
      * Path to html icon file.
+     * @default ''
      */
     icon?: string | URL;
     /**
@@ -730,11 +757,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 +787,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 +867,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.14",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/web-infra-dev/rspress.git",
@@ -44,12 +44,12 @@
     "dist"
   ],
   "dependencies": {
-    "@rsbuild/core": "^2.0.7",
+    "@rsbuild/core": "^2.0.9",
     "@shikijs/rehype": "^4.0.2",
     "unified": "^11.0.5"
   },
   "devDependencies": {
-    "@rslib/core": "0.21.5",
+    "@rslib/core": "0.22.0",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.8.1",
     "@types/react": "^19.2.15",