@rspress/shared 0.0.0-next-20230927072732 → 0.0.0-next-20231108104528

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 {
   /**
@@ -57,7 +57,7 @@ interface Config$1 {
     /**
      * Custom outline title in the aside component.
      *
-     * @default 'On this page'
+     * @default 'ON THIS PAGE'
      */
     outlineTitle?: string;
     /**
@@ -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.
      */
@@ -119,13 +121,9 @@ interface Config$1 {
      */
     search?: boolean;
     /**
-     * Whether to use back top
-     */
-    backTop?: boolean;
-    /**
-     * Whether to hide the navbar
+     * The behavior of hiding navbar
      */
-    hideNavbar?: boolean;
+    hideNavbar?: 'always' | 'auto' | 'never';
     /**
      * Whether to enable the animation for translation pages
      */
@@ -145,7 +143,7 @@ interface LocaleConfig {
     /**
      * Theme i18n config
      */
-    nav?: NavItem[];
+    nav?: Nav;
     sidebar?: Sidebar;
     outlineTitle?: string;
     lastUpdatedText?: string;
@@ -155,6 +153,9 @@ interface LocaleConfig {
     nextPageText?: string;
     langRoutePrefix?: string;
 }
+type Nav = NavItem[] | {
+    [key: string]: NavItem[];
+};
 type NavItem = NavItemWithLink | NavItemWithChildren | NavItemWithLinkAndChildren;
 type NavItemWithLink = {
     text: string;
@@ -166,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';
@@ -182,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;
 }
@@ -197,6 +198,9 @@ type SidebarItem = {
     link: string;
     tag?: string;
 };
+type SidebarDivider = {
+    dividerType: 'dashed' | 'solid';
+};
 interface EditLink {
     /**
      * Custom repository url for edit link.
@@ -224,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 {
@@ -239,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;
@@ -282,9 +286,9 @@ interface RspressPlugin {
         globalComponents?: string[];
     };
     /**
-     * Builder config.
+     * Rsbuild config.
      */
-    builderConfig?: BuilderConfig;
+    builderConfig?: RsbuildConfig;
     /**
      * Inject global components.
      */
@@ -292,29 +296,36 @@ interface RspressPlugin {
     /**
      * Modify doc config.
      */
-    config?: (config: UserConfig) => UserConfig | Promise<UserConfig>;
+    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) => 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.
      */
@@ -327,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 {
@@ -410,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
      */
@@ -449,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
      */
@@ -459,7 +474,7 @@ interface UserConfig<ThemeConfig = Config$1> {
     /**
      * Add some extra builder plugins
      */
-    builderPlugins?: BuilderPlugin[];
+    builderPlugins?: RsbuildPlugin[];
     /**
      * Multi version config
      */
@@ -479,6 +494,7 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
     root: string;
     base: string;
     lang: string;
+    route: RouteOptions;
     locales: {
         lang: string;
         label: string;
@@ -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>> {
@@ -585,6 +604,10 @@ interface RouteOptions {
      * Exclude files from being converted to routes
      */
     exclude?: string[];
+    /**
+     * use links without .html files
+     */
+    cleanUrls?: boolean;
 }
 interface SearchHooks {
     /**
@@ -610,10 +633,31 @@ type SearchOptions = LocalSearchOptions | RemoteSearchOptions | false;
 interface MarkdownOptions {
     remarkPlugins?: PluggableList;
     rehypePlugins?: PluggableList;
+    /**
+     * Whether to enable check dead links, default is false
+     */
     checkDeadLinks?: boolean;
-    experimentalMdxRs?: boolean;
     showLineNumbers?: boolean;
+    /**
+     * Whether to wrap code by default, default is false
+     */
+    defaultWrapCode?: boolean;
+    /**
+     * Register global components in mdx files
+     */
     globalComponents?: string[];
+    /**
+     * Register prism languages
+     */
+    highlightLanguages?: (string | [string, string])[];
+    /**
+     * Whether to enable mdx-rs, default is true
+     */
+    mdxRs?: boolean;
+    /**
+     * @deprecated, use `mdxRs` instead
+     */
+    experimentalMdxRs?: boolean;
 }
 type Config = UserConfig | Promise<UserConfig> | ((env: any) => UserConfig | Promise<UserConfig>);
 
@@ -632,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;
@@ -643,6 +688,11 @@ declare function replaceLang(rawUrl: string, lang: {
     current: string;
     default: string;
 }, base?: string): string;
+declare function replaceVersion(rawUrl: string, version: {
+    current: string;
+    target: string;
+    default: string;
+}, base?: string): string;
 declare const omit: (obj: Record<string, unknown>, keys: string[]) => {
     [x: string]: unknown;
 };
@@ -650,7 +700,7 @@ declare const parseUrl: (url: string) => {
     url: string;
     hash: string;
 };
-declare function normalizeHref(url?: string): string;
+declare function normalizeHref(url?: string, cleanUrls?: boolean): string;
 declare function withoutLang(path: string, langs: string[]): string;
 declare function withoutBase(path: string, base?: string): string;
 declare function withBase(url?: string, base?: string): string;
@@ -658,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, 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

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -26,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,
@@ -42,6 +44,7 @@ __export(src_exports, {
   removeLeadingSlash: () => removeLeadingSlash,
   removeTrailingSlash: () => removeTrailingSlash,
   replaceLang: () => replaceLang,
+  replaceVersion: () => replaceVersion,
   slash: () => slash,
   withBase: () => withBase,
   withoutBase: () => withoutBase,
@@ -1150,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;
 }
@@ -1190,6 +1196,30 @@ function replaceLang(rawUrl, lang, version, base = "") {
     base
   );
 }
+function replaceVersion(rawUrl, version, base = "") {
+  let url = removeBase(rawUrl, base);
+  if (!url) {
+    url = "/index.html";
+  }
+  let versionPart = "";
+  const parts = url.split("/").filter(Boolean);
+  if (version.target !== version.default) {
+    versionPart = version.target;
+    if (version.current !== version.default) {
+      parts.shift();
+    }
+  } else {
+    parts.shift();
+  }
+  let restPart = parts.join("/") || "";
+  if (versionPart && !restPart) {
+    restPart = "index.html";
+  }
+  return withBase(
+    addLeadingSlash([versionPart, restPart].filter(Boolean).join("/")),
+    base
+  );
+}
 var omit = (obj, keys) => {
   const ret = { ...obj };
   for (const key of keys) {
@@ -1204,7 +1234,7 @@ var parseUrl = (url) => {
     hash
   };
 };
-function normalizeHref(url) {
+function normalizeHref(url, cleanUrls = false) {
   if (!url) {
     return "/";
   }
@@ -1215,7 +1245,7 @@ function normalizeHref(url) {
   if (url.startsWith("mailto:") || url.startsWith("tel:")) {
     return url;
   }
-  if (!cleanUrl2.endsWith(".html")) {
+  if (!cleanUrls && !cleanUrl2.endsWith(".html")) {
     if (cleanUrl2.endsWith("/")) {
       cleanUrl2 += "index.html";
     } else {
@@ -1237,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];
@@ -1261,6 +1294,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   RSPRESS_TEMP_DIR,
   SEARCH_INDEX_NAME,
   addLeadingSlash,
+  addTrailingSlash,
   cleanUrl,
   inBrowser,
   isDebugMode,
@@ -1277,6 +1311,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   removeLeadingSlash,
   removeTrailingSlash,
   replaceLang,
+  replaceVersion,
   slash,
   withBase,
   withoutBase,