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

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.
@@ -143,7 +143,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 +220,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 +273,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 +328,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;
 };
@@ -352,23 +350,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<PluginShikiOptions>;
     /**
-     * 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;
 
@@ -413,12 +412,16 @@ export declare interface NormalizedLocales extends Omit<LocaleConfig, 'sidebar'>
     sidebar: NormalizedSidebar;
 }
 
+export declare interface NormalizedRuntimeConfig {
+    base: string;
+}
+
 export declare interface NormalizedSidebar {
     [path: string]: (NormalizedSidebarGroup | SidebarItem | SidebarDivider)[];
 }
 
 export declare interface NormalizedSidebarGroup extends Omit<SidebarGroup, 'items'> {
-    items: (SidebarDivider | SidebarItem | NormalizedSidebarGroup)[];
+    items: (SidebarDivider | SidebarItem | SidebarSectionHeader | NormalizedSidebarGroup)[];
     collapsible: boolean;
     collapsed: boolean;
 }
@@ -447,9 +450,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 +459,6 @@ export declare interface PageIndexInfo {
     frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
-    domain: string;
     _filepath: string;
     _relativePath: string;
 }
@@ -476,6 +477,8 @@ export declare const parseUrl: (url: string) => {
     hash: string;
 };
 
+declare type PluginShikiOptions = RehypeShikiOptions;
+
 export declare const QUERY_REGEXP: RegExp;
 
 export declare type RemotePageInfo = PageIndexInfo & {
@@ -487,20 +490,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;
@@ -622,6 +611,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>>;
     /**
@@ -658,7 +648,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)[];
@@ -672,7 +662,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;
     /**
@@ -702,7 +692,6 @@ export declare type SidebarSectionHeader = {
 
 export declare interface SiteData<ThemeConfig = NormalizedConfig> {
     root: string;
-    base: string;
     lang: string;
     route: RouteOptions;
     locales: {
@@ -724,7 +713,7 @@ export declare interface SiteData<ThemeConfig = NormalizedConfig> {
     markdown: {
         showLineNumbers: boolean;
         defaultWrapCode: boolean;
-        codeHighlighter: 'prism' | 'shiki';
+        shiki: Partial<PluginShikiOptions>;
     };
     multiVersion: {
         default: string;
@@ -770,7 +759,7 @@ export declare interface UserConfig<ThemeConfig = DefaultThemeConfig> {
     /**
      * Path to html icon file.
      */
-    icon?: string;
+    icon?: string | URL;
     /**
      * Default language of the site.
      */
@@ -852,10 +841,6 @@ export declare interface UserConfig<ThemeConfig = DefaultThemeConfig> {
         selector?: string;
         options?: ZoomOptions;
     };
-    /**
-     * Add some extra builder plugins
-     */
-    builderPlugins?: RsbuildPlugin[];
     /**
      * Multi version config
      */
@@ -890,8 +875,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,3 +1,18 @@
+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?$/;
@@ -30,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;
@@ -100,11 +114,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 +131,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('#');
@@ -145,9 +159,6 @@ 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 withBase(url, base) {
     const normalizedUrl = addLeadingSlash(url);
     const normalizedBase = normalizeSlash(base);
@@ -156,21 +167,4 @@ function withBase(url, base) {
 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 };
+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/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.
@@ -131,7 +131,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 +207,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 +257,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 +305,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;
 };
@@ -314,13 +327,14 @@ declare interface MarkdownOptions {
      */
     globalComponents?: string[];
     /**
-     * Code highlighter, default is prism for performance reason
+     * @type import('@shikijs/rehype').RehypeShikiOptions
      */
-    codeHighlighter?: 'prism' | 'shiki';
+    shiki?: Partial<PluginShikiOptions>;
     /**
-     * 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 +375,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,26 +384,13 @@ 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 PluginShikiOptions = RehypeShikiOptions;
 
 declare interface ReplaceRule {
     search: string | RegExp;
@@ -476,6 +476,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>>;
     /**
@@ -508,7 +509,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 +523,7 @@ declare interface SidebarGroup {
     text: string;
     link?: string;
     tag?: string;
-    items: (SidebarItem | SidebarDivider | SidebarGroup | string)[];
+    items: (SidebarGroup | SidebarItem | SidebarDivider | SidebarSectionHeader)[];
     collapsible?: boolean;
     collapsed?: boolean;
     /**
@@ -586,7 +587,7 @@ declare interface UserConfig<ThemeConfig = Config> {
     /**
      * Path to html icon file.
      */
-    icon?: string;
+    icon?: string | URL;
     /**
      * Default language of the site.
      */
@@ -668,10 +669,6 @@ declare interface UserConfig<ThemeConfig = Config> {
         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.2",
+  "version": "2.0.0-beta.21",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/web-infra-dev/rspress.git",
@@ -32,21 +32,22 @@
     "dist"
   ],
   "dependencies": {
-    "@rsbuild/core": "1.3.9",
+    "@rsbuild/core": "~1.4.6",
+    "@shikijs/rehype": "^3.4.2",
     "gray-matter": "4.0.3",
     "lodash-es": "^4.17.21",
     "unified": "^11.0.5"
   },
   "devDependencies": {
-    "@rslib/core": "0.6.5",
+    "@rslib/core": "0.10.5",
     "@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.8",
     "mdast-util-mdx-jsx": "^3.2.0",
     "medium-zoom": "1.1.0",
     "rimraf": "^6.0.1",
-    "rsbuild-plugin-publint": "^0.3.0",
+    "rsbuild-plugin-publint": "^0.3.2",
     "typescript": "^5.8.2"
   },
   "publishConfig": {