@rspress/shared 1.17.1 → 1.18.0

package/dist/index.d.ts

@@ -47,6 +47,89 @@ interface ZoomContainer {
   left?: number
 }
 
+/**
+ * There are two ways to define what addtion routes represent.
+ * 1. Define filepath, then the content will be read from the file.
+ * 2. Define content, then then content will be written to temp file and read from it.
+ */
+interface AdditionalPage {
+    routePath: string;
+    content?: string;
+    filepath?: string;
+}
+interface RspressPlugin {
+    /**
+     * Name of the plugin.
+     */
+    name: string;
+    /**
+     * Global style
+     */
+    globalStyles?: string;
+    /**
+     * Markdown options.
+     */
+    markdown?: {
+        remarkPlugins?: PluggableList;
+        rehypePlugins?: PluggableList;
+        globalComponents?: string[];
+    };
+    /**
+     * Rsbuild config.
+     */
+    builderConfig?: RsbuildConfig;
+    /**
+     * Inject global components.
+     */
+    globalUIComponents?: (string | [string, object])[];
+    /**
+     * Modify doc config.
+     */
+    config?: (config: UserConfig, utils: {
+        addPlugin: (plugin: RspressPlugin) => void;
+        removePlugin: (pluginName: string) => void;
+    }, isProd: boolean) => UserConfig | Promise<UserConfig>;
+    /**
+     * Callback before build
+     */
+    beforeBuild?: (config: UserConfig, isProd: boolean) => void | Promise<void>;
+    /**
+     * Callback after build
+     */
+    afterBuild?: (config: UserConfig, isProd: boolean) => void | Promise<void>;
+    /**
+     * Extend every page's data
+     */
+    extendPageData?: (pageData: PageIndexInfo & {
+        [key: string]: unknown;
+    }, isProd: boolean) => void | Promise<void>;
+    /**
+     * Add custom route
+     */
+    addPages?: (config: UserConfig, isProd: boolean) => AdditionalPage[] | Promise<AdditionalPage[]>;
+    /**
+     * Add runtime modules
+     */
+    addRuntimeModules?: (config: UserConfig, isProd: boolean) => Record<string, string> | Promise<Record<string, string>>;
+    /**
+     * Callback after route generated
+     */
+    routeGenerated?: (routes: RouteMeta[], 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.
+     */
+    modifySearchIndexData?: (data: PageIndexInfo[], isProd: boolean) => void | Promise<void>;
+}
+
 interface Config$1 {
     /**
      * Whether to enable dark mode.
@@ -215,6 +298,7 @@ interface SidebarGroup {
      * For hmr usage in development
      */
     _fileKey?: string;
+    overviewHeaders?: number[];
 }
 type SidebarItem = {
     text: string;
@@ -224,6 +308,7 @@ type SidebarItem = {
      * For hmr usage in development
      */
     _fileKey?: string;
+    overviewHeaders?: number[];
 };
 type SidebarDivider = {
     dividerType: 'dashed' | 'solid';
@@ -289,89 +374,6 @@ interface NormalizedConfig extends Omit<Config$1, 'locales' | 'sidebar'> {
     sidebar: NormalizedSidebar;
 }
 
-/**
- * There are two ways to define what addtion routes represent.
- * 1. Define filepath, then the content will be read from the file.
- * 2. Define content, then then content will be written to temp file and read from it.
- */
-interface AdditionalPage {
-    routePath: string;
-    content?: string;
-    filepath?: string;
-}
-interface RspressPlugin {
-    /**
-     * Name of the plugin.
-     */
-    name: string;
-    /**
-     * Global style
-     */
-    globalStyles?: string;
-    /**
-     * Markdown options.
-     */
-    markdown?: {
-        remarkPlugins?: PluggableList;
-        rehypePlugins?: PluggableList;
-        globalComponents?: string[];
-    };
-    /**
-     * Rsbuild config.
-     */
-    builderConfig?: RsbuildConfig;
-    /**
-     * Inject global components.
-     */
-    globalUIComponents?: (string | [string, object])[];
-    /**
-     * Modify doc config.
-     */
-    config?: (config: UserConfig, utils: {
-        addPlugin: (plugin: RspressPlugin) => void;
-        removePlugin: (pluginName: string) => void;
-    }, isProd: boolean) => UserConfig | Promise<UserConfig>;
-    /**
-     * Callback before build
-     */
-    beforeBuild?: (config: UserConfig, isProd: boolean) => void | Promise<void>;
-    /**
-     * Callback after build
-     */
-    afterBuild?: (config: UserConfig, isProd: boolean) => void | Promise<void>;
-    /**
-     * Extend every page's data
-     */
-    extendPageData?: (pageData: PageIndexInfo & {
-        [key: string]: unknown;
-    }, isProd: boolean) => void | Promise<void>;
-    /**
-     * Add custom route
-     */
-    addPages?: (config: UserConfig, isProd: boolean) => AdditionalPage[] | Promise<AdditionalPage[]>;
-    /**
-     * Add runtime modules
-     */
-    addRuntimeModules?: (config: UserConfig, isProd: boolean) => Record<string, string> | Promise<Record<string, string>>;
-    /**
-     * Callback after route generated
-     */
-    routeGenerated?: (routes: RouteMeta[], 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.
-     */
-    modifySearchIndexData?: (data: PageIndexInfo[], isProd: boolean) => void | Promise<void>;
-}
-
 interface Route {
     path: string;
     element: React.ReactElement;
@@ -584,6 +586,12 @@ interface Hero {
     image?: {
         src: string;
         alt: string;
+        /**
+         * `srcset` and `sizes` are attributes of `<img>` tag. Please refer to https://mdn.io/srcset for the usage.
+         * When the value is an array, rspress will join array members with commas.
+         **/
+        sizes?: string | string[];
+        srcset?: string | string[];
     };
     actions: {
         text: string;
@@ -615,6 +623,7 @@ interface FrontMatterMeta {
     sidebar?: boolean;
     outline?: boolean;
     lineNumbers?: boolean;
+    overviewHeaders?: number;
 }
 interface PageData {
     siteData: SiteData<Config$1>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "1.17.1",
+  "version": "1.18.0",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",