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

package/dist/index.d.ts

@@ -337,11 +337,7 @@ export declare type LocalSearchOptions = SearchHooks & {
 export declare interface MarkdownOptions {
     remarkPlugins?: PluggableList;
     rehypePlugins?: PluggableList;
-    /**
-     * Whether to enable check dead links
-     * @default false
-     */
-    checkDeadLinks?: boolean;
+    link?: RemarkLinkOptions;
     showLineNumbers?: boolean;
     /**
      * Whether to wrap code by default
@@ -355,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
@@ -480,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: {
@@ -550,12 +559,19 @@ 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
@@ -708,7 +724,7 @@ export declare interface SiteData<ThemeConfig = NormalizedConfig> {
     markdown: {
         showLineNumbers: boolean;
         defaultWrapCode: boolean;
-        shiki: Partial<PluginShikiOptions>;
+        shiki: Partial<RehypeShikiOptions>;
     };
     multiVersion: {
         default: string;

package/dist/node-utils.d.ts

@@ -314,11 +314,7 @@ declare type LocalSearchOptions = SearchHooks & {
 declare interface MarkdownOptions {
     remarkPlugins?: PluggableList;
     rehypePlugins?: PluggableList;
-    /**
-     * Whether to enable check dead links
-     * @default false
-     */
-    checkDeadLinks?: boolean;
+    link?: RemarkLinkOptions;
     showLineNumbers?: boolean;
     /**
      * Whether to wrap code by default
@@ -332,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
@@ -393,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;
@@ -417,12 +426,19 @@ 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

package/package.json

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