@rspress/shared 2.0.0-beta.21 → 2.0.0-beta.22

package/dist/index.d.ts

@@ -132,6 +132,7 @@ export declare interface DefaultThemeConfig {
     enableContentAnimation?: boolean;
     /**
      * Whether to enable view transition animation for the theme
+     * @default false
      */
     enableAppearanceAnimation?: boolean;
     /**
@@ -337,12 +338,14 @@ export declare interface MarkdownOptions {
     remarkPlugins?: PluggableList;
     rehypePlugins?: PluggableList;
     /**
-     * Whether to enable check dead links, default is false
+     * Whether to enable check dead links
+     * @default false
      */
     checkDeadLinks?: boolean;
     showLineNumbers?: boolean;
     /**
-     * Whether to wrap code by default, default is false
+     * Whether to wrap code by default
+     * @default false
      */
     defaultWrapCode?: boolean;
     /**
@@ -555,6 +558,7 @@ export declare interface RouteOptions {
     exclude?: string[];
     /**
      * use links without .html files
+     * @default false
      */
     cleanUrls?: boolean;
 }
@@ -622,14 +626,6 @@ declare interface RspressPlugin {
      * Callback after routeService generated
      */
     routeServiceGenerated?: (routeService: any, isProd: boolean) => Promise<void> | void;
-    /**
-     * Add addition ssg routes, for dynamic routes.
-     */
-    addSSGRoutes?: (config: UserConfig, isProd: boolean) => {
-        path: string;
-    }[] | Promise<{
-        path: string;
-    }[]>;
     /**
      * @private
      * Modify search index data.
@@ -709,7 +705,6 @@ export declare interface SiteData<ThemeConfig = NormalizedConfig> {
     logoText: string;
     pages: BaseRuntimePageInfo[];
     search: SearchOptions;
-    ssg: boolean;
     markdown: {
         showLineNumbers: boolean;
         defaultWrapCode: boolean;
@@ -831,11 +826,24 @@ export declare interface UserConfig<ThemeConfig = DefaultThemeConfig> {
      */
     search?: SearchOptions;
     /**
-     * Whether to enable ssg, default is true
+     * Whether to enable ssg
+     * @default true
      */
-    ssg?: boolean;
+    ssg?: boolean | {
+        /**
+         * After enabled, you can use worker to accelerate the SSG process and reduce memory usage. It is suitable for large document sites and is based on [tinypool](https://github.com/tinylibs/tinypool).
+         * @default false
+         */
+        experimentalWorker?: boolean;
+        /**
+         * After enabled, some pages will not be rendered by SSG, and they will directly use html under CSR. This is suitable for SSG errors in large document sites bypassing a small number of pages. It is not recommended to enable this option actively.
+         * @default []
+         */
+        experimentalExcludeRoutePaths?: (string | RegExp)[];
+    };
     /**
-     * Whether to enable medium-zoom, default is true
+     * Whether to enable medium-zoom
+     * @default true
      */
     mediumZoom?: boolean | {
         selector?: string;

package/dist/node-utils.d.ts

@@ -120,6 +120,7 @@ declare interface Config {
     enableContentAnimation?: boolean;
     /**
      * Whether to enable view transition animation for the theme
+     * @default false
      */
     enableAppearanceAnimation?: boolean;
     /**
@@ -314,12 +315,14 @@ declare interface MarkdownOptions {
     remarkPlugins?: PluggableList;
     rehypePlugins?: PluggableList;
     /**
-     * Whether to enable check dead links, default is false
+     * Whether to enable check dead links
+     * @default false
      */
     checkDeadLinks?: boolean;
     showLineNumbers?: boolean;
     /**
-     * Whether to wrap code by default, default is false
+     * Whether to wrap code by default
+     * @default false
      */
     defaultWrapCode?: boolean;
     /**
@@ -422,6 +425,7 @@ declare interface RouteOptions {
     exclude?: string[];
     /**
      * use links without .html files
+     * @default false
      */
     cleanUrls?: boolean;
 }
@@ -487,14 +491,6 @@ declare interface RspressPlugin {
      * Callback after routeService generated
      */
     routeServiceGenerated?: (routeService: any, isProd: boolean) => Promise<void> | void;
-    /**
-     * Add addition ssg routes, for dynamic routes.
-     */
-    addSSGRoutes?: (config: UserConfig, isProd: boolean) => {
-        path: string;
-    }[] | Promise<{
-        path: string;
-    }[]>;
     /**
      * @private
      * Modify search index data.
@@ -659,11 +655,24 @@ declare interface UserConfig<ThemeConfig = Config> {
      */
     search?: SearchOptions;
     /**
-     * Whether to enable ssg, default is true
+     * Whether to enable ssg
+     * @default true
      */
-    ssg?: boolean;
+    ssg?: boolean | {
+        /**
+         * After enabled, you can use worker to accelerate the SSG process and reduce memory usage. It is suitable for large document sites and is based on [tinypool](https://github.com/tinylibs/tinypool).
+         * @default false
+         */
+        experimentalWorker?: boolean;
+        /**
+         * After enabled, some pages will not be rendered by SSG, and they will directly use html under CSR. This is suitable for SSG errors in large document sites bypassing a small number of pages. It is not recommended to enable this option actively.
+         * @default []
+         */
+        experimentalExcludeRoutePaths?: (string | RegExp)[];
+    };
     /**
-     * Whether to enable medium-zoom, default is true
+     * Whether to enable medium-zoom
+     * @default true
      */
     mediumZoom?: boolean | {
         selector?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "2.0.0-beta.21",
+  "version": "2.0.0-beta.22",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/web-infra-dev/rspress.git",
@@ -32,14 +32,14 @@
     "dist"
   ],
   "dependencies": {
-    "@rsbuild/core": "~1.4.6",
-    "@shikijs/rehype": "^3.4.2",
+    "@rsbuild/core": "~1.4.8",
+    "@shikijs/rehype": "^3.8.1",
     "gray-matter": "4.0.3",
     "lodash-es": "^4.17.21",
     "unified": "^11.0.5"
   },
   "devDependencies": {
-    "@rslib/core": "0.10.5",
+    "@rslib/core": "0.10.6",
     "@types/jest": "~29.5.14",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.8.1",