@rspress/shared 0.0.0-next-20230927072732 → 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,9 @@ interface Config$1 {
      */
     search?: boolean;
     /**
-     * Whether to use back top
+     * The behavior of hiding navbar
      */
-    backTop?: boolean;
-    /**
-     * Whether to hide the navbar
-     */
-    hideNavbar?: boolean;
+    hideNavbar?: 'always' | 'auto' | 'never';
     /**
      * Whether to enable the animation for translation pages
      */
@@ -292,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
      */
@@ -479,6 +478,7 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
     root: string;
     base: string;
     lang: string;
+    route: RouteOptions;
     locales: {
         lang: string;
         label: string;
@@ -585,6 +585,10 @@ interface RouteOptions {
      * Exclude files from being converted to routes
      */
     exclude?: string[];
+    /**
+     * use links without .html files
+     */
+    cleanUrls?: boolean;
 }
 interface SearchHooks {
     /**
@@ -610,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>);
 
@@ -643,6 +664,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 +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;
@@ -658,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,
@@ -1190,6 +1192,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 +1230,7 @@ var parseUrl = (url) => {
     hash
   };
 };
-function normalizeHref(url) {
+function normalizeHref(url, cleanUrls = false) {
   if (!url) {
     return "/";
   }
@@ -1215,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 {
@@ -1277,6 +1303,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   removeLeadingSlash,
   removeTrailingSlash,
   replaceLang,
+  replaceVersion,
   slash,
   withBase,
   withoutBase,