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

package/dist/index.d.ts

@@ -57,7 +57,7 @@ interface Config$1 {
     /**
      * Custom outline title in the aside component.
      *
-     * @default 'On this page'
+     * @default 'ON THIS PAGE'
      */
     outlineTitle?: string;
     /**
@@ -119,13 +119,13 @@ interface Config$1 {
      */
     search?: boolean;
     /**
-     * Whether to use back top
+     * The behavior of hiding navbar
      */
-    backTop?: boolean;
+    hideNavbar?: 'always' | 'auto' | 'never';
     /**
-     * Whether to hide the navbar
+     * Whether to enable the animation for translation pages
      */
-    hideNavbar?: boolean;
+    enableContentAnimation?: boolean;
 }
 /**
  * locale config
@@ -288,7 +288,10 @@ interface RspressPlugin {
     /**
      * Modify doc config.
      */
-    config?: (config: UserConfig) => UserConfig | Promise<UserConfig>;
+    config?: (config: UserConfig, utils: {
+        addPlugin: (plugin: RspressPlugin) => void;
+        removePlugin: (pluginName: string) => void;
+    }) => UserConfig | Promise<UserConfig>;
     /**
      * Callback before build
      */
@@ -339,6 +342,7 @@ interface RouteMeta {
     relativePath: string;
     pageName: string;
     lang: string;
+    version: string;
 }
 interface ReplaceRule {
     search: string | RegExp;
@@ -455,12 +459,30 @@ interface UserConfig<ThemeConfig = Config$1> {
      * 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;
+    route: RouteOptions;
+    locales: {
+        lang: string;
+        label: string;
+    }[];
     title: string;
     description: string;
     icon: string;
@@ -474,6 +496,10 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
     markdown: {
         showLineNumbers: boolean;
     };
+    multiVersion: {
+        default: string;
+        versions: string[];
+    };
 }
 type PageIndexInfo = {
     id: number;
@@ -483,6 +509,7 @@ type PageIndexInfo = {
     content: string;
     frontmatter: Record<string, unknown>;
     lang: string;
+    version: string;
     domain: string;
     _filepath: string;
     _relativePath: string;
@@ -545,14 +572,6 @@ interface PageData {
     };
 }
 interface RouteOptions {
-    /**
-     * The directory to search for pages
-     */
-    root?: string;
-    /**
-     * The basename of the site
-     */
-    prefix?: string;
     /**
      * The extension name of the filepath that will be converted to a route
      * @default ['js','jsx','ts','tsx','md','mdx']
@@ -566,6 +585,10 @@ interface RouteOptions {
      * Exclude files from being converted to routes
      */
     exclude?: string[];
+    /**
+     * use links without .html files
+     */
+    cleanUrls?: boolean;
 }
 interface SearchHooks {
     /**
@@ -591,10 +614,27 @@ 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;
+    /**
+     * 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>);
 
@@ -616,7 +656,19 @@ 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 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;
 };
@@ -624,7 +676,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;
@@ -632,4 +684,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, 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 };

package/dist/index.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -42,6 +43,7 @@ __export(src_exports, {
   removeLeadingSlash: () => removeLeadingSlash,
   removeTrailingSlash: () => removeTrailingSlash,
   replaceLang: () => replaceLang,
+  replaceVersion: () => replaceVersion,
   slash: () => slash,
   withBase: () => withBase,
   withoutBase: () => withoutBase,
@@ -1159,26 +1161,60 @@ function normalizeSlash(url) {
 function isExternalUrl(url) {
   return url.startsWith("http://") || url.startsWith("https://") || url.startsWith("mailto:") || url.startsWith("tel:");
 }
-function replaceLang(rawUrl, targetLang, defaultLang, langs, base = "") {
+function replaceLang(rawUrl, lang, version, base = "") {
   let url = removeBase(rawUrl, base);
   if (!url) {
     url = "/index.html";
   }
-  const originalLang = url.split("/")[1];
-  const inDefaultLang = !langs.includes(originalLang);
-  let result;
-  if (inDefaultLang) {
-    if (targetLang === defaultLang) {
-      result = url;
-    } else {
-      result = addLeadingSlash(`${targetLang}${url}`);
+  let versionPart = "";
+  let langPart = "";
+  let purePathPart = "";
+  const parts = url.split("/").filter(Boolean);
+  if (version.current && version.current !== version.default) {
+    versionPart = parts.shift() || "";
+  }
+  if (lang.target !== lang.default) {
+    langPart = lang.target;
+    if (lang.current !== lang.default) {
+      parts.shift();
     }
-  } else if (targetLang === defaultLang) {
-    result = url.replace(`/${originalLang}`, "");
   } else {
-    result = url.replace(originalLang, targetLang);
+    parts.shift();
+  }
+  purePathPart = parts.join("/") || "";
+  if ((versionPart || langPart) && !purePathPart) {
+    purePathPart = "index.html";
+  }
+  return withBase(
+    addLeadingSlash(
+      [versionPart, langPart, purePathPart].filter(Boolean).join("/")
+    ),
+    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(result, base);
+  return withBase(
+    addLeadingSlash([versionPart, restPart].filter(Boolean).join("/")),
+    base
+  );
 }
 var omit = (obj, keys) => {
   const ret = { ...obj };
@@ -1194,7 +1230,7 @@ var parseUrl = (url) => {
     hash
   };
 };
-function normalizeHref(url) {
+function normalizeHref(url, cleanUrls = false) {
   if (!url) {
     return "/";
   }
@@ -1205,7 +1241,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 {
@@ -1267,6 +1303,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   removeLeadingSlash,
   removeTrailingSlash,
   replaceLang,
+  replaceVersion,
   slash,
   withBase,
   withoutBase,