@rspress/shared 0.0.0-next-20231110091005 → 0.0.0-next-20231115072918

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,11 +671,13 @@ 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;
 declare const cleanUrl: (url: string) => string;
 declare function slash(str: string): string;
+declare function removeHash(str: string): string;
 declare function normalizePosixPath(id: string): string;
 declare const inBrowser: () => boolean;
 declare function addLeadingSlash(url: string): string;
@@ -708,4 +714,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, 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, 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,
@@ -41,6 +42,7 @@ __export(src_exports, {
   omit: () => omit,
   parseUrl: () => parseUrl,
   removeBase: () => removeBase,
+  removeHash: () => removeHash,
   removeLeadingSlash: () => removeLeadingSlash,
   removeTrailingSlash: () => removeTrailingSlash,
   replaceLang: () => replaceLang,
@@ -1115,6 +1117,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);
@@ -1122,6 +1140,9 @@ var cleanUrl = (url) => url.replace(HASH_REGEXP, "").replace(QUERY_REGEXP, "");
 function slash(str) {
   return str.replace(/\\/g, "/");
 }
+function removeHash(str) {
+  return str.replace(/#.*$/, "");
+}
 function normalizePosixPath(id) {
   const path = slash(id);
   const isAbsolutePath = path.startsWith("/");
@@ -1170,6 +1191,9 @@ function replaceLang(rawUrl, lang, version, base = "") {
   if (!url) {
     url = "/index.html";
   }
+  if (url.endsWith("/")) {
+    url += "index.html";
+  }
   let versionPart = "";
   let langPart = "";
   let purePathPart = "";
@@ -1245,7 +1269,8 @@ function normalizeHref(url, cleanUrls = false) {
   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 {
@@ -1288,6 +1313,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,
@@ -1308,6 +1334,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
   omit,
   parseUrl,
   removeBase,
+  removeHash,
   removeLeadingSlash,
   removeTrailingSlash,
   replaceLang,

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);
@@ -1067,6 +1083,9 @@ var cleanUrl = (url) => url.replace(HASH_REGEXP, "").replace(QUERY_REGEXP, "");
 function slash(str) {
   return str.replace(/\\/g, "/");
 }
+function removeHash(str) {
+  return str.replace(/#.*$/, "");
+}
 function normalizePosixPath(id) {
   const path = slash(id);
   const isAbsolutePath = path.startsWith("/");
@@ -1115,6 +1134,9 @@ function replaceLang(rawUrl, lang, version, base = "") {
   if (!url) {
     url = "/index.html";
   }
+  if (url.endsWith("/")) {
+    url += "index.html";
+  }
   let versionPart = "";
   let langPart = "";
   let purePathPart = "";
@@ -1190,7 +1212,8 @@ function normalizeHref(url, cleanUrls = false) {
   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 {
@@ -1232,6 +1255,7 @@ var mergeDocConfig = (...configs) => mergeWith_default({}, ...configs, (target,
 });
 export {
   APPEARANCE_KEY,
+  DEFAULT_HIGHLIGHT_LANGUAGES,
   HASH_REGEXP,
   MDX_REGEXP,
   QUERY_REGEXP,
@@ -1252,6 +1276,7 @@ export {
   omit,
   parseUrl,
   removeBase,
+  removeHash,
   removeLeadingSlash,
   removeTrailingSlash,
   replaceLang,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "0.0.0-next-20231110091005",
+  "version": "0.0.0-next-20231115072918",
   "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-20231115072032",
     "unified": "10.1.2",
     "chalk": "4.1.2",
     "rslog": "^1.1.0"