@rspress/shared 0.0.0-next-20240407073144 → 0.0.0-next-20240415093056

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.
@@ -201,7 +284,6 @@ type Image = string | {
     src: string;
     alt?: string;
 };
-type OverViewDepth = 'h1' | 'h2';
 interface Sidebar {
     [path: string]: (SidebarGroup | SidebarItem | SidebarDivider | SidebarSectionHeader)[];
 }
@@ -216,7 +298,7 @@ interface SidebarGroup {
      * For hmr usage in development
      */
     _fileKey?: string;
-    overviewDepth?: OverViewDepth;
+    overviewHeaders?: number[];
 }
 type SidebarItem = {
     text: string;
@@ -226,7 +308,7 @@ type SidebarItem = {
      * For hmr usage in development
      */
     _fileKey?: string;
-    overviewDepth?: OverViewDepth;
+    overviewHeaders?: number[];
 };
 type SidebarDivider = {
     dividerType: 'dashed' | 'solid';
@@ -292,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;
@@ -587,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;
@@ -618,6 +623,7 @@ interface FrontMatterMeta {
     sidebar?: boolean;
     outline?: boolean;
     lineNumbers?: boolean;
+    overviewHeaders?: number;
 }
 interface PageData {
     siteData: SiteData<Config$1>;
@@ -761,4 +767,4 @@ declare function removeBase(url: string, base: string): string;
 declare function withoutHash(url: string): string;
 declare const mergeDocConfig: (...configs: UserConfig[]) => UserConfig;
 
-export { APPEARANCE_KEY, type AdditionalPage, type BaseRuntimePageInfo, type Config, DEFAULT_HIGHLIGHT_LANGUAGES, type Config$1 as DefaultThemeConfig, type DocFooter, type EditLink, type Feature, type Footer, type FrontMatterMeta, HASH_REGEXP, type Header, type Hero, type Image, type LocalSearchOptions, type Locale, type LocaleConfig, type LocaleLink, type LocaleLinks, MDX_REGEXP, type MarkdownOptions, type MdxRsOptions, type Nav, type NavItem, type NavItemWithChildren, type NavItemWithLink, type NavItemWithLinkAndChildren, type NormalizedConfig, type NormalizedConfig as NormalizedDefaultThemeConfig, type NormalizedLocales, type NormalizedSidebar, type NormalizedSidebarGroup, type OverViewDepth, type PageData, type PageIndexInfo, type PageModule, type PageType, type RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, type RemotePageInfo, type RemoteSearchIndexInfo, type RemoteSearchOptions, type ReplaceRule, type Route, type RouteMeta, type RouteOptions, type RspressPlugin, SEARCH_INDEX_NAME, type SearchHooks, type SearchOptions, type Sidebar, type SidebarDivider, type SidebarGroup, type SidebarItem, type SidebarSectionHeader, type SiteData, type SocialLink, type SocialLinkIcon, type UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDataUrl, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };
+export { APPEARANCE_KEY, type AdditionalPage, type BaseRuntimePageInfo, type Config, DEFAULT_HIGHLIGHT_LANGUAGES, type Config$1 as DefaultThemeConfig, type DocFooter, type EditLink, type Feature, type Footer, type FrontMatterMeta, HASH_REGEXP, type Header, type Hero, type Image, type LocalSearchOptions, type Locale, type LocaleConfig, type LocaleLink, type LocaleLinks, MDX_REGEXP, type MarkdownOptions, type MdxRsOptions, type Nav, type NavItem, type NavItemWithChildren, type NavItemWithLink, type NavItemWithLinkAndChildren, type NormalizedConfig, type NormalizedConfig as NormalizedDefaultThemeConfig, type NormalizedLocales, type NormalizedSidebar, type NormalizedSidebarGroup, type PageData, type PageIndexInfo, type PageModule, type PageType, type RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, type RemotePageInfo, type RemoteSearchIndexInfo, type RemoteSearchOptions, type ReplaceRule, type Route, type RouteMeta, type RouteOptions, type RspressPlugin, SEARCH_INDEX_NAME, type SearchHooks, type SearchOptions, type Sidebar, type SidebarDivider, type SidebarGroup, type SidebarItem, type SidebarSectionHeader, type SiteData, type SocialLink, type SocialLinkIcon, type UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDataUrl, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "0.0.0-next-20240407073144",
+  "version": "0.0.0-next-20240415093056",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -11,38 +11,38 @@
   },
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.js"
     },
     "./execa": {
+      "types": "./dist/execa.d.ts",
       "import": "./dist/execa.mjs",
-      "require": "./dist/execa.js",
-      "types": "./dist/execa.d.ts"
+      "require": "./dist/execa.js"
     },
     "./chalk": {
+      "types": "./dist/chalk.d.ts",
       "import": "./dist/chalk.mjs",
-      "require": "./dist/chalk.js",
-      "types": "./dist/chalk.d.ts"
+      "require": "./dist/chalk.js"
     },
     "./fs-extra": {
+      "types": "./dist/fs-extra.d.ts",
       "import": "./dist/fs-extra.mjs",
-      "require": "./dist/fs-extra.js",
-      "types": "./dist/fs-extra.d.ts"
+      "require": "./dist/fs-extra.js"
     },
     "./logger": {
+      "types": "./dist/logger.d.ts",
       "import": "./dist/logger.mjs",
-      "require": "./dist/logger.js",
-      "types": "./dist/logger.d.ts"
+      "require": "./dist/logger.js"
     },
     "./node-utils": {
+      "types": "./dist/node-utils.d.ts",
       "import": "./dist/node-utils.mjs",
-      "require": "./dist/node-utils.js",
-      "types": "./dist/node-utils.d.ts"
+      "require": "./dist/node-utils.js"
     }
   },
   "dependencies": {
-    "@rsbuild/core": "0.5.1",
+    "@rsbuild/core": "0.6.1",
     "unified": "10.1.2",
     "chalk": "4.1.2",
     "execa": "5.1.1",
@@ -53,7 +53,7 @@
     "lodash-es": "^4.17.21",
     "@types/interpret": "^1.1.1",
     "@types/jest": "~29.2.4",
-    "@types/lodash": "^4.14.197",
+    "@types/lodash": "^4.17.0",
     "@types/lodash-es": "^4.17.8",
     "@types/node": "~16.11.7",
     "@types/react": "~18.0.26",