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

package/dist/index.d.ts

@@ -2,7 +2,6 @@ import type { loadConfig } from '@rsbuild/core';
 import type { PluggableList } from 'unified';
 import type { RehypeShikiOptions } from '@shikijs/rehype';
 import type { RsbuildConfig } from '@rsbuild/core';
-import type { RsbuildPlugin } from '@rsbuild/core';
 
 /**
  * There are two ways to define what addition routes represent.
@@ -133,6 +132,7 @@ export declare interface DefaultThemeConfig {
     enableContentAnimation?: boolean;
     /**
      * Whether to enable view transition animation for the theme
+     * @default false
      */
     enableAppearanceAnimation?: boolean;
     /**
@@ -274,8 +274,6 @@ export declare function isExternalUrl(url?: string): boolean;
 
 export declare const isProduction: () => boolean;
 
-export declare const isSCM: () => boolean;
-
 export declare interface Locale {
     lang: string;
     label: string;
@@ -340,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;
     /**
@@ -462,7 +462,6 @@ export declare interface PageIndexInfo {
     frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
-    domain: string;
     _filepath: string;
     _relativePath: string;
 }
@@ -494,20 +493,6 @@ export declare type RemotePageInfo = PageIndexInfo & {
     };
 };
 
-export declare type RemoteSearchIndexInfo = string | {
-    value: string;
-    label: string;
-};
-
-export declare type RemoteSearchOptions = SearchHooks & {
-    mode: 'remote';
-    apiUrl: string;
-    domain?: string;
-    indexName: string;
-    searchIndexes?: RemoteSearchIndexInfo[];
-    searchLoading?: boolean;
-};
-
 export declare function removeBase(url: string, base: string): string;
 
 export declare function removeHash(str: string): string;
@@ -573,6 +558,7 @@ export declare interface RouteOptions {
     exclude?: string[];
     /**
      * use links without .html files
+     * @default false
      */
     cleanUrls?: boolean;
 }
@@ -640,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.
@@ -666,7 +644,7 @@ export declare interface SearchHooks {
     searchHooks?: string;
 }
 
-export declare type SearchOptions = LocalSearchOptions | RemoteSearchOptions | false;
+export declare type SearchOptions = LocalSearchOptions | false;
 
 export declare interface Sidebar {
     [path: string]: (SidebarGroup | SidebarItem | SidebarDivider | SidebarSectionHeader)[];
@@ -727,7 +705,6 @@ export declare interface SiteData<ThemeConfig = NormalizedConfig> {
     logoText: string;
     pages: BaseRuntimePageInfo[];
     search: SearchOptions;
-    ssg: boolean;
     markdown: {
         showLineNumbers: boolean;
         defaultWrapCode: boolean;
@@ -849,20 +826,29 @@ 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;
         options?: ZoomOptions;
     };
-    /**
-     * Add some extra builder plugins
-     */
-    builderPlugins?: RsbuildPlugin[];
     /**
      * Multi version config
      */

package/dist/index.js

@@ -45,7 +45,6 @@ const DEFAULT_HIGHLIGHT_LANGUAGES = [
         'tsx'
     ]
 ];
-const isSCM = ()=>Boolean(process.env.BUILD_VERSION);
 const isProduction = ()=>'production' === process.env.NODE_ENV;
 const isDebugMode = ()=>{
     if (!process.env.DEBUG) return false;
@@ -168,4 +167,4 @@ function withBase(url, base) {
 function removeBase(url, base) {
     return addLeadingSlash(url).replace(new RegExp(`^${normalizeSlash(base)}`), '');
 }
-export { APPEARANCE_KEY, DEFAULT_HIGHLIGHT_LANGUAGES, HASH_REGEXP, MDX_OR_MD_REGEXP, QUERY_REGEXP, RSPRESS_TEMP_DIR, SEARCH_INDEX_NAME, addLeadingSlash, addTrailingSlash, utils_cleanUrl as cleanUrl, getSidebarDataGroup, inBrowser, isDataUrl, isDebugMode, isDevDebugMode, isExternalUrl, isProduction, isSCM, matchNavbar, matchSidebar, normalizeHref, normalizePosixPath, normalizeSlash, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutLang };
+export { APPEARANCE_KEY, DEFAULT_HIGHLIGHT_LANGUAGES, HASH_REGEXP, MDX_OR_MD_REGEXP, QUERY_REGEXP, RSPRESS_TEMP_DIR, SEARCH_INDEX_NAME, addLeadingSlash, addTrailingSlash, utils_cleanUrl as cleanUrl, getSidebarDataGroup, inBrowser, isDataUrl, isDebugMode, isDevDebugMode, isExternalUrl, isProduction, matchNavbar, matchSidebar, normalizeHref, normalizePosixPath, normalizeSlash, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutLang };

package/dist/node-utils.d.ts

@@ -6,7 +6,6 @@ import type { MdxJsxTextElement } from 'mdast-util-mdx-jsx';
 import type { PluggableList } from 'unified';
 import type { RehypeShikiOptions } from '@shikijs/rehype';
 import type { RsbuildConfig } from '@rsbuild/core';
-import type { RsbuildPlugin } from '@rsbuild/core';
 
 /**
  * There are two ways to define what addition routes represent.
@@ -121,6 +120,7 @@ declare interface Config {
     enableContentAnimation?: boolean;
     /**
      * Whether to enable view transition animation for the theme
+     * @default false
      */
     enableAppearanceAnimation?: boolean;
     /**
@@ -315,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;
     /**
@@ -385,7 +387,6 @@ declare interface PageIndexInfo {
     frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
-    domain: string;
     _filepath: string;
     _relativePath: string;
 }
@@ -394,20 +395,6 @@ declare type PageType = 'home' | 'doc' | 'custom' | '404' | 'blank';
 
 declare type PluginShikiOptions = RehypeShikiOptions;
 
-declare type RemoteSearchIndexInfo = string | {
-    value: string;
-    label: string;
-};
-
-declare type RemoteSearchOptions = SearchHooks & {
-    mode: 'remote';
-    apiUrl: string;
-    domain?: string;
-    indexName: string;
-    searchIndexes?: RemoteSearchIndexInfo[];
-    searchLoading?: boolean;
-};
-
 declare interface ReplaceRule {
     search: string | RegExp;
     replace: string;
@@ -438,6 +425,7 @@ declare interface RouteOptions {
     exclude?: string[];
     /**
      * use links without .html files
+     * @default false
      */
     cleanUrls?: boolean;
 }
@@ -503,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.
@@ -525,7 +505,7 @@ declare interface SearchHooks {
     searchHooks?: string;
 }
 
-declare type SearchOptions = LocalSearchOptions | RemoteSearchOptions | false;
+declare type SearchOptions = LocalSearchOptions | false;
 
 declare interface Sidebar {
     [path: string]: (SidebarGroup | SidebarItem | SidebarDivider | SidebarSectionHeader)[];
@@ -675,20 +655,29 @@ 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;
         options?: ZoomOptions;
     };
-    /**
-     * Add some extra builder plugins
-     */
-    builderPlugins?: RsbuildPlugin[];
     /**
      * Multi version config
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "2.0.0-beta.20",
+  "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.3",
-    "@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.4",
+    "@rslib/core": "0.10.6",
     "@types/jest": "~29.5.14",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.8.1",