@rspress/shared 0.0.0-next-20231113024827 → 0.0.0-next-20231207111357

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import { RsbuildPlugin } from '@rsbuild/core';
-import { RsbuildConfig } from '@rsbuild/core/rspack-provider';
+import { RsbuildConfig, RsbuildPlugin } from '@rsbuild/core';
 import { PluggableList } from 'unified';
 
 interface ZoomOptions {
@@ -513,6 +512,7 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
     markdown: {
         showLineNumbers: boolean;
         defaultWrapCode: boolean;
+        codeHighlighter: 'prism' | 'shiki';
     };
     multiVersion: {
         default: string;
@@ -646,6 +646,10 @@ interface MarkdownOptions {
      * Register global components in mdx files
      */
     globalComponents?: string[];
+    /**
+     * Code highlighter, default is prism for performance reason
+     */
+    codeHighlighter?: 'prism' | 'shiki';
     /**
      * Register prism languages
      */
@@ -667,6 +671,7 @@ declare const MDX_REGEXP: RegExp;
 declare const APPEARANCE_KEY = "rspress-theme-appearance";
 declare const SEARCH_INDEX_NAME = "search_index";
 declare const RSPRESS_TEMP_DIR = ".rspress";
+declare const DEFAULT_HIGHLIGHT_LANGUAGES: (string | string[])[];
 declare const isSCM: () => boolean;
 declare const isProduction: () => boolean;
 declare const isDebugMode: () => boolean;
@@ -680,7 +685,8 @@ declare function removeLeadingSlash(url: string): string;
 declare function addTrailingSlash(url: string): string;
 declare function removeTrailingSlash(url: string): string;
 declare function normalizeSlash(url: string): string;
-declare function isExternalUrl(url: string): boolean;
+declare function isExternalUrl(url?: string): boolean;
+declare function isDataUrl(url?: string): boolean;
 declare function replaceLang(rawUrl: string, lang: {
     current: string;
     target: string;
@@ -709,4 +715,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, 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, 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, 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

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   APPEARANCE_KEY: () => APPEARANCE_KEY,
+  DEFAULT_HIGHLIGHT_LANGUAGES: () => DEFAULT_HIGHLIGHT_LANGUAGES,
   HASH_REGEXP: () => HASH_REGEXP,
   MDX_REGEXP: () => MDX_REGEXP,
   QUERY_REGEXP: () => QUERY_REGEXP,
@@ -30,6 +31,7 @@ __export(src_exports, {
   addTrailingSlash: () => addTrailingSlash,
   cleanUrl: () => cleanUrl,
   inBrowser: () => inBrowser,
+  isDataUrl: () => isDataUrl,
   isDebugMode: () => isDebugMode,
   isExternalUrl: () => isExternalUrl,
   isProduction: () => isProduction,
@@ -1116,6 +1118,22 @@ var MDX_REGEXP = /\.mdx?$/;
 var APPEARANCE_KEY = "rspress-theme-appearance";
 var SEARCH_INDEX_NAME = "search_index";
 var RSPRESS_TEMP_DIR = ".rspress";
+var DEFAULT_HIGHLIGHT_LANGUAGES = [
+  ["js", "javascript"],
+  ["ts", "typescript"],
+  ["jsx", "tsx"],
+  "tsx",
+  "json",
+  "css",
+  "scss",
+  "less",
+  ["xml", "xml-doc"],
+  "diff",
+  "yaml",
+  ["md", "markdown"],
+  ["mdx", "tsx"],
+  "bash"
+];
 var isSCM = () => Boolean(process.env.BUILD_VERSION);
 var isProduction = () => process.env.NODE_ENV === "production";
 var isDebugMode = () => Boolean(process.env.DOC_DEBUG);
@@ -1166,9 +1184,12 @@ function removeTrailingSlash(url) {
 function normalizeSlash(url) {
   return removeTrailingSlash(addLeadingSlash(normalizePosixPath(url)));
 }
-function isExternalUrl(url) {
+function isExternalUrl(url = "") {
   return url.startsWith("http://") || url.startsWith("https://") || url.startsWith("mailto:") || url.startsWith("tel:");
 }
+function isDataUrl(url = "") {
+  return /^\s*data:/i.test(url);
+}
 function replaceLang(rawUrl, lang, version, base = "") {
   let url = removeBase(rawUrl, base);
   if (!url) {
@@ -1249,16 +1270,17 @@ function normalizeHref(url, cleanUrls = false) {
     return url;
   }
   let { url: cleanUrl2, hash } = parseUrl(decodeURIComponent(url));
-  if (url.startsWith("mailto:") || url.startsWith("tel:")) {
-    return url;
-  }
-  if (!cleanUrls && !cleanUrl2.endsWith(".html")) {
+  const hasExt = cleanUrl2.split("/").pop()?.includes(".");
+  if (!cleanUrls && !cleanUrl2.endsWith(".html") && !hasExt) {
     if (cleanUrl2.endsWith("/")) {
       cleanUrl2 += "index.html";
     } else {
       cleanUrl2 += ".html";
     }
   }
+  if (cleanUrls && cleanUrl2.endsWith("/")) {
+    cleanUrl2 += "index";
+  }
   return addLeadingSlash(hash ? `${cleanUrl2}#${hash}` : cleanUrl2);
 }
 function withoutLang(path, langs) {
@@ -1295,6 +1317,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   APPEARANCE_KEY,
+  DEFAULT_HIGHLIGHT_LANGUAGES,
   HASH_REGEXP,
   MDX_REGEXP,
   QUERY_REGEXP,
@@ -1304,6 +1327,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   addTrailingSlash,
   cleanUrl,
   inBrowser,
+  isDataUrl,
   isDebugMode,
   isExternalUrl,
   isProduction,

package/dist/index.mjs

@@ -1060,6 +1060,22 @@ var MDX_REGEXP = /\.mdx?$/;
 var APPEARANCE_KEY = "rspress-theme-appearance";
 var SEARCH_INDEX_NAME = "search_index";
 var RSPRESS_TEMP_DIR = ".rspress";
+var DEFAULT_HIGHLIGHT_LANGUAGES = [
+  ["js", "javascript"],
+  ["ts", "typescript"],
+  ["jsx", "tsx"],
+  "tsx",
+  "json",
+  "css",
+  "scss",
+  "less",
+  ["xml", "xml-doc"],
+  "diff",
+  "yaml",
+  ["md", "markdown"],
+  ["mdx", "tsx"],
+  "bash"
+];
 var isSCM = () => Boolean(process.env.BUILD_VERSION);
 var isProduction = () => process.env.NODE_ENV === "production";
 var isDebugMode = () => Boolean(process.env.DOC_DEBUG);
@@ -1110,9 +1126,12 @@ function removeTrailingSlash(url) {
 function normalizeSlash(url) {
   return removeTrailingSlash(addLeadingSlash(normalizePosixPath(url)));
 }
-function isExternalUrl(url) {
+function isExternalUrl(url = "") {
   return url.startsWith("http://") || url.startsWith("https://") || url.startsWith("mailto:") || url.startsWith("tel:");
 }
+function isDataUrl(url = "") {
+  return /^\s*data:/i.test(url);
+}
 function replaceLang(rawUrl, lang, version, base = "") {
   let url = removeBase(rawUrl, base);
   if (!url) {
@@ -1193,16 +1212,17 @@ function normalizeHref(url, cleanUrls = false) {
     return url;
   }
   let { url: cleanUrl2, hash } = parseUrl(decodeURIComponent(url));
-  if (url.startsWith("mailto:") || url.startsWith("tel:")) {
-    return url;
-  }
-  if (!cleanUrls && !cleanUrl2.endsWith(".html")) {
+  const hasExt = cleanUrl2.split("/").pop()?.includes(".");
+  if (!cleanUrls && !cleanUrl2.endsWith(".html") && !hasExt) {
     if (cleanUrl2.endsWith("/")) {
       cleanUrl2 += "index.html";
     } else {
       cleanUrl2 += ".html";
     }
   }
+  if (cleanUrls && cleanUrl2.endsWith("/")) {
+    cleanUrl2 += "index";
+  }
   return addLeadingSlash(hash ? `${cleanUrl2}#${hash}` : cleanUrl2);
 }
 function withoutLang(path, langs) {
@@ -1238,6 +1258,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
 });
 export {
   APPEARANCE_KEY,
+  DEFAULT_HIGHLIGHT_LANGUAGES,
   HASH_REGEXP,
   MDX_REGEXP,
   QUERY_REGEXP,
@@ -1247,6 +1268,7 @@ export {
   addTrailingSlash,
   cleanUrl,
   inBrowser,
+  isDataUrl,
   isDebugMode,
   isExternalUrl,
   isProduction,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "0.0.0-next-20231113024827",
+  "version": "0.0.0-next-20231207111357",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -22,7 +22,7 @@
     }
   },
   "dependencies": {
-    "@rsbuild/core": "0.0.14",
+    "@rsbuild/core": "0.0.0-next-20231207110454",
     "unified": "10.1.2",
     "chalk": "4.1.2",
     "rslog": "^1.1.0"
@@ -47,6 +47,7 @@
     "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
+  "license": "MIT",
   "files": [
     "bin",
     "dist"