@rspress/shared 1.9.0 → 1.9.2

package/dist/index.d.ts

@@ -635,6 +635,12 @@ type RemoteSearchOptions = SearchHooks & {
     searchIndexes?: RemoteSearchIndexInfo[];
 };
 type SearchOptions = LocalSearchOptions | RemoteSearchOptions | false;
+interface MdxRsOptions {
+    /**
+     * Determine whether the file use mdxRs compiler
+     */
+    include?: (filepath: string) => boolean;
+}
 interface MarkdownOptions {
     remarkPlugins?: PluggableList;
     rehypePlugins?: PluggableList;
@@ -662,7 +668,7 @@ interface MarkdownOptions {
     /**
      * Whether to enable mdx-rs, default is true
      */
-    mdxRs?: boolean;
+    mdxRs?: boolean | MdxRsOptions;
     /**
      * @deprecated, use `mdxRs` instead
      */
@@ -699,12 +705,12 @@ declare function replaceLang(rawUrl: string, lang: {
 }, version: {
     current: string;
     default: string;
-}, base?: string): string;
+}, base?: string, cleanUrls?: boolean): string;
 declare function replaceVersion(rawUrl: string, version: {
     current: string;
     target: string;
     default: string;
-}, base?: string): string;
+}, base?: string, cleanUrls?: boolean): string;
 declare const omit: (obj: Record<string, unknown>, keys: string[]) => {
     [x: string]: unknown;
 };
@@ -720,4 +726,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, DEFAULT_HIGHLIGHT_LANGUAGES, 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, isDataUrl, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };
+export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, DEFAULT_HIGHLIGHT_LANGUAGES, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, MdxRsOptions, 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, isDataUrl, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };

package/dist/index.js

@@ -1190,13 +1190,13 @@ function isExternalUrl(url = "") {
 function isDataUrl(url = "") {
   return /^\s*data:/i.test(url);
 }
-function replaceLang(rawUrl, lang, version, base = "") {
+function replaceLang(rawUrl, lang, version, base = "", cleanUrls = false) {
   let url = removeBase(rawUrl, base);
   if (!url) {
-    url = "/index.html";
+    url = cleanUrls ? "/index" : "/index.html";
   }
   if (url.endsWith("/")) {
-    url += "index.html";
+    url += cleanUrls ? "/index" : "/index.html";
   }
   let versionPart = "";
   let langPart = "";
@@ -1215,7 +1215,7 @@ function replaceLang(rawUrl, lang, version, base = "") {
   }
   purePathPart = parts.join("/") || "";
   if ((versionPart || langPart) && !purePathPart) {
-    purePathPart = "index.html";
+    purePathPart = cleanUrls ? "index" : "index.html";
   }
   return withBase(
     addLeadingSlash(
@@ -1224,10 +1224,10 @@ function replaceLang(rawUrl, lang, version, base = "") {
     base
   );
 }
-function replaceVersion(rawUrl, version, base = "") {
+function replaceVersion(rawUrl, version, base = "", cleanUrls = false) {
   let url = removeBase(rawUrl, base);
   if (!url) {
-    url = "/index.html";
+    url = cleanUrls ? "/index" : "/index.html";
   }
   let versionPart = "";
   const parts = url.split("/").filter(Boolean);
@@ -1241,7 +1241,7 @@ function replaceVersion(rawUrl, version, base = "") {
   }
   let restPart = parts.join("/") || "";
   if (versionPart && !restPart) {
-    restPart = "index.html";
+    restPart = cleanUrls ? "index" : "index.html";
   }
   return withBase(
     addLeadingSlash([versionPart, restPart].filter(Boolean).join("/")),

package/dist/index.mjs

@@ -1132,13 +1132,13 @@ function isExternalUrl(url = "") {
 function isDataUrl(url = "") {
   return /^\s*data:/i.test(url);
 }
-function replaceLang(rawUrl, lang, version, base = "") {
+function replaceLang(rawUrl, lang, version, base = "", cleanUrls = false) {
   let url = removeBase(rawUrl, base);
   if (!url) {
-    url = "/index.html";
+    url = cleanUrls ? "/index" : "/index.html";
   }
   if (url.endsWith("/")) {
-    url += "index.html";
+    url += cleanUrls ? "/index" : "/index.html";
   }
   let versionPart = "";
   let langPart = "";
@@ -1157,7 +1157,7 @@ function replaceLang(rawUrl, lang, version, base = "") {
   }
   purePathPart = parts.join("/") || "";
   if ((versionPart || langPart) && !purePathPart) {
-    purePathPart = "index.html";
+    purePathPart = cleanUrls ? "index" : "index.html";
   }
   return withBase(
     addLeadingSlash(
@@ -1166,10 +1166,10 @@ function replaceLang(rawUrl, lang, version, base = "") {
     base
   );
 }
-function replaceVersion(rawUrl, version, base = "") {
+function replaceVersion(rawUrl, version, base = "", cleanUrls = false) {
   let url = removeBase(rawUrl, base);
   if (!url) {
-    url = "/index.html";
+    url = cleanUrls ? "/index" : "/index.html";
   }
   let versionPart = "";
   const parts = url.split("/").filter(Boolean);
@@ -1183,7 +1183,7 @@ function replaceVersion(rawUrl, version, base = "") {
   }
   let restPart = parts.join("/") || "";
   if (versionPart && !restPart) {
-    restPart = "index.html";
+    restPart = cleanUrls ? "index" : "index.html";
   }
   return withBase(
     addLeadingSlash([versionPart, restPart].filter(Boolean).join("/")),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "1.9.0",
+  "version": "1.9.2",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",