@rspress/shared 0.0.0-next-20230824072138 → 0.0.0-next-20230925114748

package/dist/index.d.ts

@@ -2,6 +2,52 @@ 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.
@@ -80,6 +126,10 @@ interface Config$1 {
      * Whether to hide the navbar
      */
     hideNavbar?: boolean;
+    /**
+     * Whether to enable the animation for translation pages
+     */
+    enableContentAnimation?: boolean;
 }
 /**
  * locale config
@@ -105,7 +155,7 @@ interface LocaleConfig {
     nextPageText?: string;
     langRoutePrefix?: string;
 }
-type NavItem = NavItemWithLink | NavItemWithChildren;
+type NavItem = NavItemWithLink | NavItemWithChildren | NavItemWithLinkAndChildren;
 type NavItemWithLink = {
     text: string;
     link: string;
@@ -116,7 +166,15 @@ type NavItemWithLink = {
 interface NavItemWithChildren {
     text?: string;
     tag?: string;
-    items: (NavItemWithChildren | NavItemWithLink)[];
+    items: NavItem[];
+    position?: 'left' | 'right';
+}
+interface NavItemWithLinkAndChildren {
+    text: string;
+    link: string;
+    items: NavItem[];
+    tag?: string;
+    activeMatch?: string;
     position?: 'left' | 'right';
 }
 type Image = string | {
@@ -230,7 +288,7 @@ interface RspressPlugin {
     /**
      * Inject global components.
      */
-    globalUIComponents?: string[];
+    globalUIComponents?: (string | [string, object])[];
     /**
      * Modify doc config.
      */
@@ -285,6 +343,7 @@ interface RouteMeta {
     relativePath: string;
     pageName: string;
     lang: string;
+    version: string;
 }
 interface ReplaceRule {
     search: string | RegExp;
@@ -381,7 +440,7 @@ interface UserConfig<ThemeConfig = Config$1> {
     /**
      * Global components
      */
-    globalUIComponents?: string[];
+    globalUIComponents?: (string | [string, object])[];
     /**
      * Global styles, is a Absolute path
      */
@@ -395,17 +454,35 @@ interface UserConfig<ThemeConfig = Config$1> {
      */
     mediumZoom?: boolean | {
         selector?: string;
+        options?: ZoomOptions;
     };
     /**
      * Add some extra builder plugins
      */
     builderPlugins?: BuilderPlugin[];
+    /**
+     * Multi version config
+     */
+    multiVersion?: {
+        /**
+         * The default version
+         */
+        default?: string;
+        /**
+         * The version list, such as ['v1', 'v2']
+         */
+        versions: string[];
+    };
 }
 type BaseRuntimePageInfo = Omit<PageIndexInfo, 'id' | 'content' | 'domain'>;
 interface SiteData<ThemeConfig = NormalizedConfig> {
     root: string;
     base: string;
     lang: string;
+    locales: {
+        lang: string;
+        label: string;
+    }[];
     title: string;
     description: string;
     icon: string;
@@ -419,6 +496,10 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
     markdown: {
         showLineNumbers: boolean;
     };
+    multiVersion: {
+        default: string;
+        versions: string[];
+    };
 }
 type PageIndexInfo = {
     id: number;
@@ -428,6 +509,7 @@ type PageIndexInfo = {
     content: string;
     frontmatter: Record<string, unknown>;
     lang: string;
+    version: string;
     domain: string;
     _filepath: string;
     _relativePath: string;
@@ -546,19 +628,29 @@ 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 = "modern-theme-appearance";
+declare const APPEARANCE_KEY = "rspress-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;
 declare const cleanUrl: (url: string) => string;
+declare function slash(str: string): string;
+declare function normalizePosixPath(id: string): string;
 declare const inBrowser: () => boolean;
 declare function addLeadingSlash(url: string): string;
 declare function removeLeadingSlash(url: string): string;
 declare function removeTrailingSlash(url: string): string;
 declare function normalizeSlash(url: string): string;
 declare function isExternalUrl(url: string): boolean;
-declare function replaceLang(rawUrl: string, targetLang: string, defaultLang: string, langs: string[], base?: string): string;
+declare function replaceLang(rawUrl: string, lang: {
+    current: string;
+    target: string;
+    default: string;
+}, version: {
+    current: string;
+    default: string;
+}, base?: string): string;
 declare const omit: (obj: Record<string, unknown>, keys: string[]) => {
     [x: string]: unknown;
 };
@@ -574,4 +666,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, 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, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, 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, 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 };