@rspress/shared 2.0.0-beta.1 → 2.0.0-beta.11

package/dist/index.d.ts

@@ -1,5 +1,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';
 
@@ -143,7 +144,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
@@ -330,7 +331,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,13 +353,9 @@ export declare interface MarkdownOptions {
      */
     globalComponents?: string[];
     /**
-     * Code highlighter, default is prism for performance reason
+     * @type import('@shikijs/rehype').RehypeShikiOptions
      */
-    codeHighlighter?: 'prism' | 'shiki';
-    /**
-     * Register prism languages
-     */
-    highlightLanguages?: (string | [string, string])[];
+    shiki?: Partial<PluginShikiOptions>;
 }
 
 export declare const matchNavbar: (item: NavItemWithLink, currentPathname: string, base: string) => boolean;
@@ -476,6 +473,8 @@ export declare const parseUrl: (url: string) => {
     hash: string;
 };
 
+declare type PluginShikiOptions = RehypeShikiOptions;
+
 export declare const QUERY_REGEXP: RegExp;
 
 export declare type RemotePageInfo = PageIndexInfo & {
@@ -724,7 +723,7 @@ export declare interface SiteData<ThemeConfig = NormalizedConfig> {
     markdown: {
         showLineNumbers: boolean;
         defaultWrapCode: boolean;
-        codeHighlighter: 'prism' | 'shiki';
+        shiki: Partial<PluginShikiOptions>;
     };
     multiVersion: {
         default: 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.
      */

package/dist/node-utils.d.ts

@@ -4,6 +4,7 @@ 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';
 
@@ -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;
 };
@@ -314,13 +328,9 @@ declare interface MarkdownOptions {
      */
     globalComponents?: string[];
     /**
-     * Code highlighter, default is prism for performance reason
+     * @type import('@shikijs/rehype').RehypeShikiOptions
      */
-    codeHighlighter?: 'prism' | 'shiki';
-    /**
-     * Register prism languages
-     */
-    highlightLanguages?: (string | [string, string])[];
+    shiki?: Partial<PluginShikiOptions>;
 }
 
 export declare const mergeDocConfig: (...configs: UserConfig[]) => Promise<UserConfig>;
@@ -378,6 +388,8 @@ declare interface PageIndexInfo {
 
 declare type PageType = 'home' | 'doc' | 'custom' | '404' | 'blank';
 
+declare type PluginShikiOptions = RehypeShikiOptions;
+
 declare type RemoteSearchIndexInfo = string | {
     value: string;
     label: string;
@@ -586,7 +598,7 @@ declare interface UserConfig<ThemeConfig = Config> {
     /**
      * Path to html icon file.
      */
-    icon?: string;
+    icon?: string | URL;
     /**
      * Default language of the site.
      */

package/dist/node-utils.js

@@ -1,4 +1,5 @@
 import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
+import * as __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__ from "node:url";
 import * as __WEBPACK_EXTERNAL_MODULE_gray_matter_90c6cd0b__ from "gray-matter";
 import * as __WEBPACK_EXTERNAL_MODULE__rsbuild_core_1b356efc__ from "@rsbuild/core";
 const extractTextAndId = (title)=>{
@@ -14,6 +15,13 @@ const extractTextAndId = (title)=>{
         customId
     ];
 };
+function getIconUrlPath(icon) {
+    if (!icon) return;
+    icon = icon.toString();
+    if (icon.startsWith('file://')) icon = (0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.fileURLToPath)(icon);
+    if (!__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].isAbsolute(icon)) return icon;
+    return `/${__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].basename(icon)}`;
+}
 function getNodeAttribute(node, attrName, attribute) {
     const found = node.attributes.find((attr)=>'name' in attr && attr.name === attrName);
     return attribute ? found : found?.value;
@@ -21,16 +29,20 @@ function getNodeAttribute(node, attrName, attribute) {
 function loadFrontMatter(source, filepath, root, outputWarning = false) {
     try {
         const { content, data } = (0, __WEBPACK_EXTERNAL_MODULE_gray_matter_90c6cd0b__["default"])(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);
     }
     return {
         content: '',
-        frontmatter: {}
+        frontmatter: {},
+        emptyLinesSource: source
     };
 }
 const castArray = (value)=>Array.isArray(value) ? value : [
@@ -50,4 +62,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.1",
+  "version": "2.0.0-beta.11",
   "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.3.21",
+    "@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.8.0",
     "@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.6",
     "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": {