@rspress/shared 0.0.0-next-20231020055855 → 0.0.0-next-20231110091005

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { BuilderConfig } from '@modern-js/builder-rspack-provider';
+import { RsbuildPlugin } from '@rsbuild/core';
+import { RsbuildConfig } from '@rsbuild/core/rspack-provider';
 import { PluggableList } from 'unified';
-import { BuilderPlugin } from '@modern-js/builder';
 
 interface ZoomOptions {
   /**
@@ -65,9 +65,11 @@ interface Config$1 {
      */
     outline?: boolean;
     /**
-     * The nav items.
+     * The nav items. When it's an object, the key is the version of current doc.
      */
-    nav?: NavItem[];
+    nav?: NavItem[] | {
+        [key: string]: NavItem[];
+    };
     /**
      * The sidebar items.
      */
@@ -141,7 +143,7 @@ interface LocaleConfig {
     /**
      * Theme i18n config
      */
-    nav?: NavItem[];
+    nav?: Nav;
     sidebar?: Sidebar;
     outlineTitle?: string;
     lastUpdatedText?: string;
@@ -151,6 +153,9 @@ interface LocaleConfig {
     nextPageText?: string;
     langRoutePrefix?: string;
 }
+type Nav = NavItem[] | {
+    [key: string]: NavItem[];
+};
 type NavItem = NavItemWithLink | NavItemWithChildren | NavItemWithLinkAndChildren;
 type NavItemWithLink = {
     text: string;
@@ -162,13 +167,13 @@ type NavItemWithLink = {
 interface NavItemWithChildren {
     text?: string;
     tag?: string;
-    items: NavItem[];
+    items: NavItemWithLink[];
     position?: 'left' | 'right';
 }
 interface NavItemWithLinkAndChildren {
     text: string;
     link: string;
-    items: NavItem[];
+    items: NavItemWithLink[];
     tag?: string;
     activeMatch?: string;
     position?: 'left' | 'right';
@@ -178,13 +183,13 @@ type Image = string | {
     alt?: string;
 };
 interface Sidebar {
-    [path: string]: (SidebarGroup | SidebarItem)[];
+    [path: string]: (SidebarGroup | SidebarItem | SidebarDivider)[];
 }
 interface SidebarGroup {
     text: string;
     link?: string;
     tag?: string;
-    items: (SidebarItem | SidebarGroup | string)[];
+    items: (SidebarItem | SidebarDivider | SidebarGroup | string)[];
     collapsible?: boolean;
     collapsed?: boolean;
 }
@@ -193,6 +198,9 @@ type SidebarItem = {
     link: string;
     tag?: string;
 };
+type SidebarDivider = {
+    dividerType: 'dashed' | 'solid';
+};
 interface EditLink {
     /**
      * Custom repository url for edit link.
@@ -220,7 +228,7 @@ interface SocialLink {
     mode: 'link' | 'text' | 'img';
     content: string;
 }
-type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'twitter' | 'youtube' | 'weixin' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | {
+type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'twitter' | 'youtube' | 'wechat' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | {
     svg: string;
 };
 interface Footer {
@@ -235,12 +243,12 @@ interface LocaleLink {
     link: string;
 }
 interface NormalizedSidebarGroup extends Omit<SidebarGroup, 'items'> {
-    items: (SidebarItem | NormalizedSidebarGroup)[];
+    items: (SidebarDivider | SidebarItem | NormalizedSidebarGroup)[];
     collapsible: boolean;
     collapsed: boolean;
 }
 interface NormalizedSidebar {
-    [path: string]: (NormalizedSidebarGroup | SidebarItem)[];
+    [path: string]: (NormalizedSidebarGroup | SidebarItem | SidebarDivider)[];
 }
 interface NormalizedLocales extends Omit<LocaleConfig, 'sidebar'> {
     sidebar: NormalizedSidebar;
@@ -278,9 +286,9 @@ interface RspressPlugin {
         globalComponents?: string[];
     };
     /**
-     * Builder config.
+     * Rsbuild config.
      */
-    builderConfig?: BuilderConfig;
+    builderConfig?: RsbuildConfig;
     /**
      * Inject global components.
      */
@@ -291,29 +299,33 @@ interface RspressPlugin {
     config?: (config: UserConfig, utils: {
         addPlugin: (plugin: RspressPlugin) => void;
         removePlugin: (pluginName: string) => void;
-    }) => UserConfig | Promise<UserConfig>;
+    }, isProd: boolean) => UserConfig | Promise<UserConfig>;
     /**
      * Callback before build
      */
-    beforeBuild?: (config: UserConfig, isProd: boolean) => Promise<void>;
+    beforeBuild?: (config: UserConfig, isProd: boolean) => void | Promise<void>;
     /**
      * Callback after build
      */
-    afterBuild?: (config: UserConfig, isProd: boolean) => Promise<void>;
+    afterBuild?: (config: UserConfig, isProd: boolean) => void | Promise<void>;
     /**
      * Extend every page's data
      */
     extendPageData?: (pageData: PageIndexInfo & {
         [key: string]: unknown;
-    }) => void | Promise<void>;
+    }, 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[]) => Promise<void> | void;
+    routeGenerated?: (routes: RouteMeta[], isProd: boolean) => Promise<void> | void;
     /**
      * Add addition ssg routes, for dynamic routes.
      */
@@ -326,7 +338,7 @@ interface RspressPlugin {
      * @private
      * Modify search index data.
      */
-    modifySearchIndexData?: (data: PageIndexInfo[]) => void | Promise<void>;
+    modifySearchIndexData?: (data: PageIndexInfo[], isProd: boolean) => void | Promise<void>;
 }
 
 interface Route {
@@ -409,9 +421,9 @@ interface UserConfig<ThemeConfig = Config$1> {
      */
     themeConfig?: ThemeConfig;
     /**
-     * Builder Configuration
+     * Rsbuild Configuration
      */
-    builderConfig?: BuilderConfig;
+    builderConfig?: RsbuildConfig;
     /**
      * The custom config of vite-plugin-route
      */
@@ -448,6 +460,10 @@ interface UserConfig<ThemeConfig = Config$1> {
      * Search options
      */
     search?: SearchOptions;
+    /**
+     * Whether to enable ssg, default is true
+     */
+    ssg?: boolean;
     /**
      * Whether to enable medium-zoom, default is true
      */
@@ -458,7 +474,7 @@ interface UserConfig<ThemeConfig = Config$1> {
     /**
      * Add some extra builder plugins
      */
-    builderPlugins?: BuilderPlugin[];
+    builderPlugins?: RsbuildPlugin[];
     /**
      * Multi version config
      */
@@ -493,8 +509,10 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
     };
     pages: BaseRuntimePageInfo[];
     search: SearchOptions;
+    ssg: boolean;
     markdown: {
         showLineNumbers: boolean;
+        defaultWrapCode: boolean;
     };
     multiVersion: {
         default: string;
@@ -540,6 +558,7 @@ interface Feature {
     icon: string;
     title: string;
     details: string;
+    span?: number;
     link?: string;
 }
 interface PageModule<T extends React.ComponentType<unknown>> {
@@ -619,6 +638,10 @@ interface MarkdownOptions {
      */
     checkDeadLinks?: boolean;
     showLineNumbers?: boolean;
+    /**
+     * Whether to wrap code by default, default is false
+     */
+    defaultWrapCode?: boolean;
     /**
      * Register global components in mdx files
      */
@@ -653,6 +676,7 @@ declare function normalizePosixPath(id: string): string;
 declare const inBrowser: () => boolean;
 declare function addLeadingSlash(url: string): string;
 declare function removeLeadingSlash(url: string): string;
+declare function addTrailingSlash(url: string): string;
 declare function removeTrailingSlash(url: string): string;
 declare function normalizeSlash(url: string): string;
 declare function isExternalUrl(url: string): boolean;
@@ -684,4 +708,4 @@ declare function removeBase(url: string, base: string): string;
 declare function withoutHash(url: string): string;
 declare const mergeDocConfig: (...configs: UserConfig[]) => UserConfig;
 
-export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, NavItem, NavItemWithChildren, NavItemWithLink, NavItemWithLinkAndChildren, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, RemotePageInfo, RemoteSearchIndexInfo, RemoteSearchOptions, ReplaceRule, Route, RouteMeta, RouteOptions, RspressPlugin, SEARCH_INDEX_NAME, SearchHooks, SearchOptions, Sidebar, SidebarGroup, SidebarItem, SiteData, SocialLink, SocialLinkIcon, UserConfig, addLeadingSlash, cleanUrl, inBrowser, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };
+export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, Nav, NavItem, NavItemWithChildren, NavItemWithLink, NavItemWithLinkAndChildren, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, RemotePageInfo, RemoteSearchIndexInfo, RemoteSearchOptions, ReplaceRule, Route, RouteMeta, RouteOptions, RspressPlugin, SEARCH_INDEX_NAME, SearchHooks, SearchOptions, Sidebar, SidebarDivider, SidebarGroup, SidebarItem, SiteData, SocialLink, SocialLinkIcon, UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };

package/dist/index.js

@@ -27,6 +27,7 @@ __export(src_exports, {
   RSPRESS_TEMP_DIR: () => RSPRESS_TEMP_DIR,
   SEARCH_INDEX_NAME: () => SEARCH_INDEX_NAME,
   addLeadingSlash: () => addLeadingSlash,
+  addTrailingSlash: () => addTrailingSlash,
   cleanUrl: () => cleanUrl,
   inBrowser: () => inBrowser,
   isDebugMode: () => isDebugMode,
@@ -1152,6 +1153,9 @@ function addLeadingSlash(url) {
 function removeLeadingSlash(url) {
   return url.charAt(0) === "/" ? url.slice(1) : url;
 }
+function addTrailingSlash(url) {
+  return url.charAt(url.length - 1) === "/" ? url : `${url}/`;
+}
 function removeTrailingSlash(url) {
   return url.charAt(url.length - 1) === "/" ? url.slice(0, -1) : url;
 }
@@ -1263,7 +1267,10 @@ function withBase(url = "/", base = "") {
   return normalizedUrl.startsWith(normalizedBase) ? normalizedUrl : `${normalizedBase}${normalizedUrl}`;
 }
 function removeBase(url, base) {
-  return addLeadingSlash(url).replace(normalizeSlash(base), "");
+  return addLeadingSlash(url).replace(
+    new RegExp(`^${normalizeSlash(base)}`),
+    ""
+  );
 }
 function withoutHash(url) {
   return url.split("#")[0];
@@ -1287,6 +1294,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   RSPRESS_TEMP_DIR,
   SEARCH_INDEX_NAME,
   addLeadingSlash,
+  addTrailingSlash,
   cleanUrl,
   inBrowser,
   isDebugMode,

package/dist/index.mjs

@@ -1098,6 +1098,9 @@ function addLeadingSlash(url) {
 function removeLeadingSlash(url) {
   return url.charAt(0) === "/" ? url.slice(1) : url;
 }
+function addTrailingSlash(url) {
+  return url.charAt(url.length - 1) === "/" ? url : `${url}/`;
+}
 function removeTrailingSlash(url) {
   return url.charAt(url.length - 1) === "/" ? url.slice(0, -1) : url;
 }
@@ -1209,7 +1212,10 @@ function withBase(url = "/", base = "") {
   return normalizedUrl.startsWith(normalizedBase) ? normalizedUrl : `${normalizedBase}${normalizedUrl}`;
 }
 function removeBase(url, base) {
-  return addLeadingSlash(url).replace(normalizeSlash(base), "");
+  return addLeadingSlash(url).replace(
+    new RegExp(`^${normalizeSlash(base)}`),
+    ""
+  );
 }
 function withoutHash(url) {
   return url.split("#")[0];
@@ -1232,6 +1238,7 @@ export {
   RSPRESS_TEMP_DIR,
   SEARCH_INDEX_NAME,
   addLeadingSlash,
+  addTrailingSlash,
   cleanUrl,
   inBrowser,
   isDebugMode,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "0.0.0-next-20231020055855",
+  "version": "0.0.0-next-20231110091005",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -22,8 +22,7 @@
     }
   },
   "dependencies": {
-    "@modern-js/builder": "2.37.1",
-    "@modern-js/builder-rspack-provider": "2.37.1",
+    "@rsbuild/core": "0.0.14",
     "unified": "10.1.2",
     "chalk": "4.1.2",
     "rslog": "^1.1.0"