@rspress/shared 0.1.1 → 1.0.0-beta.0

package/dist/index.d.ts

@@ -126,6 +126,10 @@ interface Config$1 {
      * Whether to hide the navbar
      */
     hideNavbar?: boolean;
+    /**
+     * Whether to enable the animation for translation pages
+     */
+    enableContentAnimation?: boolean;
 }
 /**
  * locale config
@@ -339,6 +343,7 @@ interface RouteMeta {
     relativePath: string;
     pageName: string;
     lang: string;
+    version: string;
 }
 interface ReplaceRule {
     search: string | RegExp;
@@ -455,12 +460,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 +497,10 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
     markdown: {
         showLineNumbers: boolean;
     };
+    multiVersion: {
+        default: string;
+        versions: string[];
+    };
 }
 type PageIndexInfo = {
     id: number;
@@ -483,6 +510,7 @@ type PageIndexInfo = {
     content: string;
     frontmatter: Record<string, unknown>;
     lang: string;
+    version: string;
     domain: string;
     _filepath: string;
     _relativePath: string;
@@ -545,14 +573,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 +586,10 @@ interface RouteOptions {
      * Exclude files from being converted to routes
      */
     exclude?: string[];
+    /**
+     * use links without .html files
+     */
+    cleanUrls?: boolean;
 }
 interface SearchHooks {
     /**
@@ -616,7 +640,14 @@ 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 const omit: (obj: Record<string, unknown>, keys: string[]) => {
     [x: string]: unknown;
 };
@@ -624,7 +655,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;

package/dist/index.js

@@ -1159,26 +1159,36 @@ 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(result, base);
+  return withBase(
+    addLeadingSlash(
+      [versionPart, langPart, purePathPart].filter(Boolean).join("/")
+    ),
+    base
+  );
 }
 var omit = (obj, keys) => {
   const ret = { ...obj };
@@ -1194,7 +1204,7 @@ var parseUrl = (url) => {
     hash
   };
 };
-function normalizeHref(url) {
+function normalizeHref(url, cleanUrls = false) {
   if (!url) {
     return "/";
   }
@@ -1205,7 +1215,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 {

package/dist/index.mjs

@@ -1113,26 +1113,35 @@ 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(result, base);
+  return withBase(addLeadingSlash([
+    versionPart,
+    langPart,
+    purePathPart
+  ].filter(Boolean).join("/")), base);
 }
 var omit = (obj, keys) => {
   const ret = {
@@ -1150,7 +1159,7 @@ var parseUrl = (url) => {
     hash
   };
 };
-function normalizeHref(url) {
+function normalizeHref(url, cleanUrls = false) {
   if (!url) {
     return "/";
   }
@@ -1161,7 +1170,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 {

package/package.json

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