@rspress/shared 2.0.0-beta.3 → 2.0.0-beta.30

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 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.
@@ -28,8 +28,6 @@ export declare const cleanUrl: (url: string) => string;
 
 export declare type Config = UserConfig | Promise<UserConfig> | ((...args: Parameters<typeof loadConfig>) => UserConfig | Promise<UserConfig>);
 
-export declare const DEFAULT_HIGHLIGHT_LANGUAGES: string[][];
-
 export declare interface DefaultThemeConfig {
     /**
      * Whether to enable dark mode.
@@ -132,6 +130,7 @@ export declare interface DefaultThemeConfig {
     enableContentAnimation?: boolean;
     /**
      * Whether to enable view transition animation for the theme
+     * @default false
      */
     enableAppearanceAnimation?: boolean;
     /**
@@ -143,7 +142,7 @@ export declare interface DefaultThemeConfig {
      * Whether to redirect to the closest locale when the user visits the site
      * @default 'auto'
      */
-    localeRedirect?: 'auto' | 'never';
+    localeRedirect?: 'auto' | 'never' | 'only-default-lang';
     /**
      * Whether to show the fallback heading title when the heading title is not presented but `frontmatter.title` exists
      * @default true
@@ -220,7 +219,7 @@ export declare interface FrontMatterMeta {
  * @param currentPathname
  * @returns
  */
-export declare const getSidebarDataGroup: (sidebar: NormalizedSidebar, currentPathname: string, base: string) => NormalizedSidebar[string];
+export declare const getSidebarDataGroup: (sidebar: NormalizedSidebar, currentPathname: string) => NormalizedSidebar[string];
 
 export declare const HASH_REGEXP: RegExp;
 
@@ -273,8 +272,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;
@@ -330,7 +327,7 @@ export declare type LocalSearchOptions = SearchHooks & {
     versioned?: boolean;
     /**
      * If enabled, the search index will include code block content, which allows users to search code blocks.
-     * @default false
+     * @default true
      */
     codeBlocks?: boolean;
 };
@@ -338,13 +335,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,23 +347,24 @@ export declare interface MarkdownOptions {
      */
     globalComponents?: string[];
     /**
-     * Code highlighter, default is prism for performance reason
+     * @type import('@shikijs/rehype').RehypeShikiOptions
      */
-    codeHighlighter?: 'prism' | 'shiki';
+    shiki?: Partial<RehypeShikiOptions>;
     /**
-     * Register prism languages
+     * Speed up build time by caching mdx parsing result in `rspress build`
+     * @default true
      */
-    highlightLanguages?: (string | [string, string])[];
+    crossCompilerCache?: boolean;
 }
 
-export declare const matchNavbar: (item: NavItemWithLink, currentPathname: string, base: string) => boolean;
+export declare const matchNavbar: (item: NavItemWithLink, currentPathname: string) => boolean;
 
 /**
  * match the sidebar key in user config
  * @param pattern /zh/guide
  * @param currentPathname /base/zh/guide/getting-started
  */
-export declare const matchSidebar: (pattern: string, currentPathname: string, base: string) => boolean;
+export declare const matchSidebar: (pattern: string, currentPathname: string) => boolean;
 
 export declare const MDX_OR_MD_REGEXP: RegExp;
 
@@ -418,19 +414,23 @@ export declare interface NormalizedSidebar {
 }
 
 export declare interface NormalizedSidebarGroup extends Omit<SidebarGroup, 'items'> {
-    items: (SidebarDivider | SidebarItem | NormalizedSidebarGroup)[];
+    items: SidebarData;
     collapsible: boolean;
     collapsed: boolean;
 }
 
-export declare function normalizeHref(url?: string, cleanUrls?: boolean): string;
+export declare function normalizeHref(url?: string, cleanUrls?: boolean, assetExtensions?: string[]): string;
 
 export declare function normalizePosixPath(id: string): string;
 
-export declare function normalizeSlash(url: string): string;
-
 export declare interface PageData {
-    siteData: SiteData<DefaultThemeConfig>;
+    pages: BaseRuntimePageInfo[];
+}
+
+export declare interface PageDataLegacy {
+    siteData: SiteData<DefaultThemeConfig> & {
+        pages: BaseRuntimePageInfo[];
+    };
     page: BaseRuntimePageInfo & {
         headingTitle?: string;
         pagePath: string;
@@ -447,9 +447,8 @@ export declare interface PageData {
  * and should not be used in the runtime (usePageData).
  */
 export declare interface PageIndexInfo {
-    id: number;
-    title: string;
     routePath: string;
+    title: string;
     toc: Header[];
     content: string;
     _flattenContent?: string;
@@ -457,7 +456,6 @@ export declare interface PageIndexInfo {
     frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
-    domain: string;
     _filepath: string;
     _relativePath: string;
 }
@@ -478,6 +476,21 @@ export declare const parseUrl: (url: string) => {
 
 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: {
@@ -487,20 +500,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;
@@ -558,14 +557,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,6 +629,7 @@ declare interface RspressPlugin {
     addPages?: (config: UserConfig, isProd: boolean) => AdditionalPage[] | Promise<AdditionalPage[]>;
     /**
      * Add runtime modules
+     * @deprecated use [rsbuild-plugin-virtual-module](https://github.com/rspack-contrib/rsbuild-plugin-virtual-module) instead.
      */
     addRuntimeModules?: (config: UserConfig, isProd: boolean) => Record<string, string> | Promise<Record<string, string>>;
     /**
@@ -632,14 +640,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.
@@ -658,12 +658,14 @@ 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)[];
 }
 
+export declare type SidebarData = (SidebarDivider | SidebarItem | SidebarSectionHeader | NormalizedSidebarGroup)[];
+
 export declare type SidebarDivider = {
     dividerType: 'dashed' | 'solid';
 };
@@ -672,7 +674,7 @@ export declare interface SidebarGroup {
     text: string;
     link?: string;
     tag?: string;
-    items: (SidebarItem | SidebarDivider | SidebarGroup | string)[];
+    items: (SidebarGroup | SidebarItem | SidebarDivider | SidebarSectionHeader)[];
     collapsible?: boolean;
     collapsed?: boolean;
     /**
@@ -701,7 +703,6 @@ export declare type SidebarSectionHeader = {
 };
 
 export declare interface SiteData<ThemeConfig = NormalizedConfig> {
-    root: string;
     base: string;
     lang: string;
     route: RouteOptions;
@@ -718,13 +719,11 @@ export declare interface SiteData<ThemeConfig = NormalizedConfig> {
         light: string;
     };
     logoText: string;
-    pages: BaseRuntimePageInfo[];
     search: SearchOptions;
-    ssg: boolean;
     markdown: {
         showLineNumbers: boolean;
         defaultWrapCode: boolean;
-        codeHighlighter: 'prism' | 'shiki';
+        shiki: Partial<RehypeShikiOptions>;
     };
     multiVersion: {
         default: string;
@@ -740,7 +739,7 @@ export declare interface SocialLink {
     content: string;
 }
 
-export declare type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'x' | 'youtube' | 'wechat' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | 'X' | 'bluesky' | {
+export declare type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'x' | 'youtube' | 'wechat' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | 'X' | 'bluesky' | 'npm' | {
     svg: string;
 };
 
@@ -770,7 +769,7 @@ export declare interface UserConfig<ThemeConfig = DefaultThemeConfig> {
     /**
      * Path to html icon file.
      */
-    icon?: string;
+    icon?: string | URL;
     /**
      * Default language of the site.
      */
@@ -842,20 +841,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
      */
@@ -890,8 +898,6 @@ export declare interface UserConfig<ThemeConfig = DefaultThemeConfig> {
 
 export declare function withBase(url: string, base: string): string;
 
-export declare function withoutBase(path: string, base: string): string;
-
 export declare function withoutLang(path: string, langs: string[]): string;
 
 declare interface ZoomContainer {

package/dist/index.js

@@ -1,36 +1,24 @@
+const matchSidebar = (pattern, currentPathname)=>{
+    if (pattern === currentPathname) return true;
+    if (currentPathname.startsWith(pattern)) return true;
+    const prefixWithDot = `${pattern}.`;
+    return currentPathname.startsWith(prefixWithDot);
+};
+const getSidebarDataGroup = (sidebar, currentPathname)=>{
+    const navRoutes = Object.keys(sidebar).sort((a, b)=>b.length - a.length);
+    for (const name of navRoutes)if (matchSidebar(name, currentPathname)) {
+        const sidebarGroup = sidebar[name];
+        return sidebarGroup;
+    }
+    return [];
+};
+const matchNavbar = (item, currentPathname)=>new RegExp(item.activeMatch || item.link).test(currentPathname);
 const QUERY_REGEXP = /\?.*$/s;
 const HASH_REGEXP = /#.*$/s;
 const MDX_OR_MD_REGEXP = /\.mdx?$/;
 const APPEARANCE_KEY = 'rspress-theme-appearance';
 const SEARCH_INDEX_NAME = 'search_index';
 const RSPRESS_TEMP_DIR = '.rspress';
-const DEFAULT_HIGHLIGHT_LANGUAGES = [
-    [
-        'js',
-        "javascript"
-    ],
-    [
-        'ts',
-        "typescript"
-    ],
-    [
-        'jsx',
-        'tsx'
-    ],
-    [
-        'xml',
-        'xml-doc'
-    ],
-    [
-        'md',
-        'markdown'
-    ],
-    [
-        'mdx',
-        'tsx'
-    ]
-];
-const isSCM = ()=>Boolean(process.env.BUILD_VERSION);
 const isProduction = ()=>'production' === process.env.NODE_ENV;
 const isDebugMode = ()=>{
     if (!process.env.DEBUG) return false;
@@ -76,9 +64,6 @@ function addTrailingSlash(url) {
 function removeTrailingSlash(url) {
     return '/' === url.charAt(url.length - 1) ? url.slice(0, -1) : url;
 }
-function normalizeSlash(url) {
-    return removeTrailingSlash(addLeadingSlash(normalizePosixPath(url)));
-}
 function isExternalUrl(url = '') {
     return url.startsWith('http://') || url.startsWith('https://') || url.startsWith('mailto:') || url.startsWith('tel:');
 }
@@ -100,11 +85,11 @@ function replaceLang(rawUrl, lang, version, base = '', cleanUrls = false, isPage
     } else parts.shift();
     purePathPart = parts.join('/') || '';
     if ((versionPart || langPart) && !purePathPart) purePathPart = cleanUrls ? 'index' : 'index.html';
-    return withBase(addLeadingSlash([
+    return addLeadingSlash([
         versionPart,
         langPart,
         purePathPart
-    ].filter(Boolean).join('/')), base);
+    ].filter(Boolean).join('/'));
 }
 function replaceVersion(rawUrl, version, base = '', cleanUrls = false, isPageNotFound = false) {
     let url = removeBase(rawUrl, base);
@@ -117,10 +102,10 @@ function replaceVersion(rawUrl, version, base = '', cleanUrls = false, isPageNot
     } else parts.shift();
     let restPart = parts.join('/') || '';
     if (versionPart && !restPart) restPart = cleanUrls ? 'index' : 'index.html';
-    return withBase(addLeadingSlash([
+    return addLeadingSlash([
         versionPart,
         restPart
-    ].filter(Boolean).join('/')), base);
+    ].filter(Boolean).join('/'));
 }
 const parseUrl = (url)=>{
     const [withoutHash, hash = ''] = url.split('#');
@@ -129,48 +114,44 @@ const parseUrl = (url)=>{
         hash
     };
 };
-function normalizeHref(url, cleanUrls = false) {
+function normalizeHref(url, cleanUrls = false, assetExtensions = []) {
     if (!url) return '/';
     if (isExternalUrl(url)) return url;
     if (url.startsWith('#')) return url;
+    if (!url.startsWith('/')) return url;
     let { url: cleanUrl, hash } = parseUrl(decodeURIComponent(url));
     if (cleanUrls) {
         if (cleanUrl.endsWith('.html')) cleanUrl = cleanUrl.replace(/\.html$/, '');
         if (cleanUrls && cleanUrl.endsWith('/index')) cleanUrl = cleanUrl.replace(/\/index$/, '/');
-    } else if (!cleanUrl.endsWith('.html')) if (cleanUrl.endsWith('/')) cleanUrl += 'index.html';
-    else cleanUrl += '.html';
+    } else {
+        const hasExt = cleanUrl.endsWith('.html') || assetExtensions.some((i)=>cleanUrl.endsWith(i));
+        if (!hasExt) if (cleanUrl.endsWith('/')) cleanUrl += 'index.html';
+        else cleanUrl += '.html';
+    }
     return addLeadingSlash(hash ? `${cleanUrl}#${hash}` : cleanUrl);
 }
 function withoutLang(path, langs) {
     const langRegexp = new RegExp(`^\\/(${langs.join('|')})`);
     return addLeadingSlash(path.replace(langRegexp, ''));
 }
-function withoutBase(path, base) {
-    return addLeadingSlash(path).replace(normalizeSlash(base), '');
+function normalizeSlash(url) {
+    return removeTrailingSlash(addLeadingSlash(normalizePosixPath(url)));
 }
 function withBase(url, base) {
     const normalizedUrl = addLeadingSlash(url);
     const normalizedBase = normalizeSlash(base);
-    return normalizedUrl.startsWith(normalizedBase) ? normalizedUrl : `${normalizedBase}${normalizedUrl}`;
+    const hasBase = normalizedUrl.startsWith(normalizedBase);
+    if (hasBase) {
+        if (normalizedUrl + '/' === base) return base;
+        return normalizedUrl;
+    }
+    return `${normalizedBase}${normalizedUrl}`;
 }
 function removeBase(url, base) {
-    return addLeadingSlash(url).replace(new RegExp(`^${normalizeSlash(base)}`), '');
-}
-const matchSidebar = (pattern, currentPathname, base)=>{
-    const prefix = withBase(pattern, base);
-    if (prefix === currentPathname) return true;
-    const prefixWithTrailingSlash = addTrailingSlash(prefix);
-    if (currentPathname.startsWith(prefixWithTrailingSlash)) return true;
-    const prefixWithDot = `${prefix}.`;
-    return currentPathname.startsWith(prefixWithDot);
-};
-const getSidebarDataGroup = (sidebar, currentPathname, base)=>{
-    const navRoutes = Object.keys(sidebar).sort((a, b)=>b.length - a.length);
-    for (const name of navRoutes)if (matchSidebar(name, currentPathname, base)) {
-        const sidebarGroup = sidebar[name];
-        return sidebarGroup;
-    }
-    return [];
-};
-const matchNavbar = (item, currentPathname, base)=>new RegExp(item.activeMatch || item.link).test(withoutBase(currentPathname, 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, withoutBase, withoutLang };
+    const normalizedUrl = addLeadingSlash(url);
+    const normalizedBase = normalizeSlash(base);
+    const removedBaseUrl = normalizedUrl.replace(new RegExp(`^${normalizedBase}`), '');
+    if ('' === removedBaseUrl) return '/';
+    return removedBaseUrl;
+}
+export { APPEARANCE_KEY, 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, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutLang };

package/dist/logger.js

@@ -1,3 +1,2 @@
-import * as __WEBPACK_EXTERNAL_MODULE__rsbuild_core_1b356efc__ from "@rsbuild/core";
-var __webpack_exports__logger = __WEBPACK_EXTERNAL_MODULE__rsbuild_core_1b356efc__.logger;
-export { __webpack_exports__logger as logger };
+import { logger } from "@rsbuild/core";
+export { logger };

package/dist/node-utils.d.ts

@@ -4,8 +4,8 @@ import type { MdxJsxExpressionAttribute } from 'mdast-util-mdx-jsx';
 import type { MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
 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.
@@ -120,6 +120,7 @@ declare interface Config {
     enableContentAnimation?: boolean;
     /**
      * Whether to enable view transition animation for the theme
+     * @default false
      */
     enableAppearanceAnimation?: boolean;
     /**
@@ -131,7 +132,7 @@ declare interface Config {
      * Whether to redirect to the closest locale when the user visits the site
      * @default 'auto'
      */
-    localeRedirect?: 'auto' | 'never';
+    localeRedirect?: 'auto' | 'never' | 'only-default-lang';
     /**
      * Whether to show the fallback heading title when the heading title is not presented but `frontmatter.title` exists
      * @default true
@@ -207,6 +208,18 @@ declare interface FrontMatterMeta {
     [key: string]: unknown;
 }
 
+/**
+ * Transform `config.icon` into final url path in the web app
+ *
+ * @param icon original icon in config
+ * @returns final url path in the web app
+ */
+export declare function getIconUrlPath(icon: '' | undefined): undefined;
+
+export declare function getIconUrlPath(icon: string | URL): string;
+
+export declare function getIconUrlPath(icon: string | URL | undefined): string | undefined;
+
 export declare function getNodeAttribute(node: MdxJsxFlowElement | MdxJsxTextElement, attrName: string, attribute?: false): string | MdxJsxAttributeValueExpression | null | undefined;
 
 export declare function getNodeAttribute(node: MdxJsxFlowElement | MdxJsxTextElement, attrName: string, attribute: true): MdxJsxAttribute | MdxJsxExpressionAttribute | undefined;
@@ -245,6 +258,7 @@ declare interface Hero {
 export declare function loadFrontMatter<TFrontmatter extends Record<string, unknown> = FrontMatterMeta>(source: string, filepath: string, root: string, outputWarning?: boolean): {
     frontmatter: TFrontmatter;
     content: string;
+    emptyLinesSource: string;
 };
 
 declare interface Locale {
@@ -292,7 +306,7 @@ declare type LocalSearchOptions = SearchHooks & {
     versioned?: boolean;
     /**
      * If enabled, the search index will include code block content, which allows users to search code blocks.
-     * @default false
+     * @default true
      */
     codeBlocks?: boolean;
 };
@@ -300,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;
     /**
@@ -314,13 +326,14 @@ declare interface MarkdownOptions {
      */
     globalComponents?: string[];
     /**
-     * Code highlighter, default is prism for performance reason
+     * @type import('@shikijs/rehype').RehypeShikiOptions
      */
-    codeHighlighter?: 'prism' | 'shiki';
+    shiki?: Partial<RehypeShikiOptions>;
     /**
-     * Register prism languages
+     * Speed up build time by caching mdx parsing result in `rspress build`
+     * @default true
      */
-    highlightLanguages?: (string | [string, string])[];
+    crossCompilerCache?: boolean;
 }
 
 export declare const mergeDocConfig: (...configs: UserConfig[]) => Promise<UserConfig>;
@@ -361,9 +374,8 @@ declare interface NavItemWithLinkAndChildren {
  * and should not be used in the runtime (usePageData).
  */
 declare interface PageIndexInfo {
-    id: number;
-    title: string;
     routePath: string;
+    title: string;
     toc: Header[];
     content: string;
     _flattenContent?: string;
@@ -371,25 +383,25 @@ declare interface PageIndexInfo {
     frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
-    domain: string;
     _filepath: string;
     _relativePath: string;
 }
 
 declare type PageType = 'home' | 'doc' | 'custom' | '404' | 'blank';
 
-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 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 {
@@ -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;
 }
@@ -476,6 +496,7 @@ declare interface RspressPlugin {
     addPages?: (config: UserConfig, isProd: boolean) => AdditionalPage[] | Promise<AdditionalPage[]>;
     /**
      * Add runtime modules
+     * @deprecated use [rsbuild-plugin-virtual-module](https://github.com/rspack-contrib/rsbuild-plugin-virtual-module) instead.
      */
     addRuntimeModules?: (config: UserConfig, isProd: boolean) => Record<string, string> | Promise<Record<string, string>>;
     /**
@@ -486,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.
@@ -508,7 +521,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)[];
@@ -522,7 +535,7 @@ declare interface SidebarGroup {
     text: string;
     link?: string;
     tag?: string;
-    items: (SidebarItem | SidebarDivider | SidebarGroup | string)[];
+    items: (SidebarGroup | SidebarItem | SidebarDivider | SidebarSectionHeader)[];
     collapsible?: boolean;
     collapsed?: boolean;
     /**
@@ -556,7 +569,7 @@ declare interface SocialLink {
     content: string;
 }
 
-declare type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'x' | 'youtube' | 'wechat' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | 'X' | 'bluesky' | {
+declare type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'x' | 'youtube' | 'wechat' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | 'X' | 'bluesky' | 'npm' | {
     svg: string;
 };
 
@@ -586,7 +599,7 @@ declare interface UserConfig<ThemeConfig = Config> {
     /**
      * Path to html icon file.
      */
-    icon?: string;
+    icon?: string | URL;
     /**
      * Default language of the site.
      */
@@ -658,20 +671,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/dist/node-utils.js

@@ -1,36 +1,54 @@
-import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
-import * as __WEBPACK_EXTERNAL_MODULE_gray_matter_90c6cd0b__ from "gray-matter";
-import * as __WEBPACK_EXTERNAL_MODULE__rsbuild_core_1b356efc__ from "@rsbuild/core";
+import node_path from "node:path";
+import { fileURLToPath } from "node:url";
+import gray_matter from "gray-matter";
+import { logger } from "@rsbuild/core";
 const extractTextAndId = (title)=>{
     if (!title) return [
         '',
         ''
     ];
     const customIdReg = /\\?{#.*}/;
-    const text = title.replace(customIdReg, '').trimEnd();
-    const customId = title.match(customIdReg)?.[0]?.slice(2, -1) || '';
+    if (customIdReg.test(title)) {
+        const text = title.replace(customIdReg, '').trimEnd();
+        const customId = title.match(customIdReg)?.[0]?.slice(2, -1) || '';
+        return [
+            text,
+            customId
+        ];
+    }
     return [
-        text,
-        customId
+        title,
+        ''
     ];
 };
+function getIconUrlPath(icon) {
+    if (!icon) return;
+    icon = icon.toString();
+    if (icon.startsWith('file://')) icon = fileURLToPath(icon);
+    if (!node_path.isAbsolute(icon)) return icon;
+    return `/${node_path.basename(icon)}`;
+}
 function getNodeAttribute(node, attrName, attribute) {
     const found = node.attributes.find((attr)=>'name' in attr && attr.name === attrName);
     return attribute ? found : found?.value;
 }
 function loadFrontMatter(source, filepath, root, outputWarning = false) {
     try {
-        const { content, data } = (0, __WEBPACK_EXTERNAL_MODULE_gray_matter_90c6cd0b__["default"])(source);
+        const { content, data } = gray_matter(source);
+        const rawFrontMatter = source.slice(0, source.length - content.length);
+        const emptyLinesSource = rawFrontMatter.length ? `${rawFrontMatter.replace(/[^\n]/g, '')}${content}` : content;
         return {
             content,
-            frontmatter: data
+            frontmatter: data,
+            emptyLinesSource
         };
     } catch (e) {
-        if (outputWarning) __WEBPACK_EXTERNAL_MODULE__rsbuild_core_1b356efc__.logger.warn(`Parse frontmatter error in ${__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].relative(root, filepath)}: \n`, e);
+        if (outputWarning) logger.warn(`Parse frontmatter error in ${node_path.relative(root, filepath)}: \n`, e);
     }
     return {
         content: '',
-        frontmatter: {}
+        frontmatter: {},
+        emptyLinesSource: source
     };
 }
 const castArray = (value)=>Array.isArray(value) ? value : [
@@ -50,4 +68,4 @@ const mergeDocConfig = async (...configs)=>{
         ];
     });
 };
-export { extractTextAndId, getNodeAttribute, loadFrontMatter, mergeDocConfig };
+export { extractTextAndId, getIconUrlPath, getNodeAttribute, loadFrontMatter, mergeDocConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.30",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/web-infra-dev/rspress.git",
@@ -32,31 +32,32 @@
     "dist"
   ],
   "dependencies": {
-    "@rsbuild/core": "1.3.13",
+    "@rsbuild/core": "~1.5.3",
+    "@shikijs/rehype": "^3.12.0",
     "gray-matter": "4.0.3",
     "lodash-es": "^4.17.21",
     "unified": "^11.0.5"
   },
   "devDependencies": {
-    "@rslib/core": "0.6.7",
+    "@rslib/core": "0.12.4",
     "@types/jest": "~29.5.14",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^18.11.17",
-    "@types/react": "^18.3.20",
+    "@types/node": "^22.8.1",
+    "@types/react": "^19.1.12",
     "mdast-util-mdx-jsx": "^3.2.0",
     "medium-zoom": "1.1.0",
     "rimraf": "^6.0.1",
-    "rsbuild-plugin-publint": "^0.3.1",
+    "rsbuild-plugin-publint": "^0.3.3",
     "typescript": "^5.8.2"
   },
   "publishConfig": {
     "access": "public",
-    "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
     "build": "rslib build",
     "build:watch": "rslib build -w",
+    "dev": "rslib build -w",
     "reset": "rimraf ./**/node_modules"
   }
 }