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

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;
     /**
@@ -336,13 +337,11 @@ export declare type LocalSearchOptions = SearchHooks & {
 export declare interface MarkdownOptions {
     remarkPlugins?: PluggableList;
     rehypePlugins?: PluggableList;
-    /**
-     * Whether to enable check dead links, default is false
-     */
-    checkDeadLinks?: boolean;
+    link?: RemarkLinkOptions;
     showLineNumbers?: boolean;
     /**
-     * Whether to wrap code by default, default is false
+     * Whether to wrap code by default
+     * @default false
      */
     defaultWrapCode?: boolean;
     /**
@@ -352,7 +351,7 @@ export declare interface MarkdownOptions {
     /**
      * @type import('@shikijs/rehype').RehypeShikiOptions
      */
-    shiki?: Partial<PluginShikiOptions>;
+    shiki?: Partial<RehypeShikiOptions>;
     /**
      * Speed up build time by caching mdx parsing result in `rspress build`
      * @default true
@@ -477,10 +476,23 @@ export declare const parseUrl: (url: string) => {
     hash: string;
 };
 
-declare type PluginShikiOptions = RehypeShikiOptions;
-
 export declare const QUERY_REGEXP: RegExp;
 
+export declare type RemarkLinkOptions = {
+    /**
+     * Whether to enable check dead links
+     * @default true
+     */
+    checkDeadLinks?: 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
+     */
+    autoPrefix?: boolean;
+};
+
 export declare type RemotePageInfo = PageIndexInfo & {
     _matchesPosition: {
         content: {
@@ -547,14 +559,22 @@ export declare interface RouteOptions {
     extensions?: string[];
     /**
      * Include extra files from being converted to routes
+     * @default []
      */
     include?: string[];
     /**
      * Exclude files from being converted to routes
+     * @default []
      */
     exclude?: string[];
+    /**
+     * Exclude convention files from being converted to routes
+     * @default ['**\/_[^_]*']
+     */
+    excludeConvention?: string[];
     /**
      * use links without .html files
+     * @default false
      */
     cleanUrls?: boolean;
 }
@@ -622,14 +642,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,11 +721,10 @@ export declare interface SiteData<ThemeConfig = NormalizedConfig> {
     logoText: string;
     pages: BaseRuntimePageInfo[];
     search: SearchOptions;
-    ssg: boolean;
     markdown: {
         showLineNumbers: boolean;
         defaultWrapCode: boolean;
-        shiki: Partial<PluginShikiOptions>;
+        shiki: Partial<RehypeShikiOptions>;
     };
     multiVersion: {
         default: string;
@@ -831,11 +842,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;
     /**
@@ -313,13 +314,11 @@ declare type LocalSearchOptions = SearchHooks & {
 declare interface MarkdownOptions {
     remarkPlugins?: PluggableList;
     rehypePlugins?: PluggableList;
-    /**
-     * Whether to enable check dead links, default is false
-     */
-    checkDeadLinks?: boolean;
+    link?: RemarkLinkOptions;
     showLineNumbers?: boolean;
     /**
-     * Whether to wrap code by default, default is false
+     * Whether to wrap code by default
+     * @default false
      */
     defaultWrapCode?: boolean;
     /**
@@ -329,7 +328,7 @@ declare interface MarkdownOptions {
     /**
      * @type import('@shikijs/rehype').RehypeShikiOptions
      */
-    shiki?: Partial<PluginShikiOptions>;
+    shiki?: Partial<RehypeShikiOptions>;
     /**
      * Speed up build time by caching mdx parsing result in `rspress build`
      * @default true
@@ -390,7 +389,20 @@ declare interface PageIndexInfo {
 
 declare type PageType = 'home' | 'doc' | 'custom' | '404' | 'blank';
 
-declare type PluginShikiOptions = RehypeShikiOptions;
+declare type RemarkLinkOptions = {
+    /**
+     * Whether to enable check dead links
+     * @default true
+     */
+    checkDeadLinks?: 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
+     */
+    autoPrefix?: boolean;
+};
 
 declare interface ReplaceRule {
     search: string | RegExp;
@@ -414,14 +426,22 @@ declare interface RouteOptions {
     extensions?: string[];
     /**
      * Include extra files from being converted to routes
+     * @default []
      */
     include?: string[];
     /**
      * Exclude files from being converted to routes
+     * @default []
      */
     exclude?: string[];
+    /**
+     * Exclude convention files from being converted to routes
+     * @default ['**\/_[^_]*']
+     */
+    excludeConvention?: string[];
     /**
      * use links without .html files
+     * @default false
      */
     cleanUrls?: boolean;
 }
@@ -487,14 +507,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 +671,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.23",
   "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.11",
+    "@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.11.0",
     "@types/jest": "~29.5.14",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.8.1",