@rspress/shared 0.0.0-nightly-20230915160133 → 0.0.1

package/dist/index.d.ts

@@ -2,52 +2,6 @@ import { BuilderConfig } from '@modern-js/builder-rspack-provider';
 import { PluggableList } from 'unified';
 import { BuilderPlugin } from '@modern-js/builder';
 
-interface ZoomOptions {
-  /**
-   * The space outside the zoomed image.
-   *
-   * @default 0
-   */
-  margin?: number
-
-  /**
-   * The background of the overlay.
-   *
-   * @default '#fff'
-   */
-  background?: string
-
-  /**
-   * The number of pixels to scroll to close the zoom.
-   *
-   * @default 40
-   */
-  scrollOffset?: number
-
-  /**
-   * The viewport to render the zoom in.
-   *
-   * @default null
-   */
-  container?: string | HTMLElement | ZoomContainer
-
-  /**
-   * The template element to display on zoom.
-   *
-   * @default null
-   */
-  template?: string | HTMLTemplateElement
-}
-
-interface ZoomContainer {
-  width?: number
-  height?: number
-  top?: number
-  bottom?: number
-  right?: number
-  left?: number
-}
-
 interface Config$1 {
     /**
      * Whether to enable dark mode.
@@ -151,7 +105,7 @@ interface LocaleConfig {
     nextPageText?: string;
     langRoutePrefix?: string;
 }
-type NavItem = NavItemWithLink | NavItemWithChildren | NavItemWithLinkAndChildren;
+type NavItem = NavItemWithLink | NavItemWithChildren;
 type NavItemWithLink = {
     text: string;
     link: string;
@@ -162,15 +116,7 @@ type NavItemWithLink = {
 interface NavItemWithChildren {
     text?: string;
     tag?: string;
-    items: NavItem[];
-    position?: 'left' | 'right';
-}
-interface NavItemWithLinkAndChildren {
-    text: string;
-    link: string;
-    items: NavItem[];
-    tag?: string;
-    activeMatch?: string;
+    items: (NavItemWithChildren | NavItemWithLink)[];
     position?: 'left' | 'right';
 }
 type Image = string | {
@@ -284,7 +230,7 @@ interface RspressPlugin {
     /**
      * Inject global components.
      */
-    globalUIComponents?: (string | [string, object])[];
+    globalUIComponents?: string[];
     /**
      * Modify doc config.
      */
@@ -435,7 +381,7 @@ interface UserConfig<ThemeConfig = Config$1> {
     /**
      * Global components
      */
-    globalUIComponents?: (string | [string, object])[];
+    globalUIComponents?: string[];
     /**
      * Global styles, is a Absolute path
      */
@@ -449,7 +395,6 @@ interface UserConfig<ThemeConfig = Config$1> {
      */
     mediumZoom?: boolean | {
         selector?: string;
-        options?: ZoomOptions;
     };
     /**
      * Add some extra builder plugins
@@ -601,9 +546,8 @@ type Config = UserConfig | Promise<UserConfig> | ((env: any) => UserConfig | Pro
 declare const QUERY_REGEXP: RegExp;
 declare const HASH_REGEXP: RegExp;
 declare const MDX_REGEXP: RegExp;
-declare const APPEARANCE_KEY = "rspress-theme-appearance";
+declare const APPEARANCE_KEY = "modern-theme-appearance";
 declare const SEARCH_INDEX_NAME = "search_index";
-declare const RSPRESS_TEMP_DIR = ".rspress";
 declare const isSCM: () => boolean;
 declare const isProduction: () => boolean;
 declare const isDebugMode: () => boolean;
@@ -632,4 +576,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, NavItem, NavItemWithChildren, NavItemWithLink, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, QUERY_REGEXP, 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 };