@rspress/plugin-medium-zoom 2.0.0-beta.2 → 2.0.0-beta.20

package/README.md

@@ -2,4 +2,4 @@
 
 > Medium zoom plugin for rspress
 
-[Documentation](https://rspress.dev/plugin/official-plugins/medium-zoom)
+[Documentation](https://rspress.rs/plugin/official-plugins/medium-zoom)

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { PluggableList } from 'unified';
+import type { RehypeShikiOptions } from '@shikijs/rehype';
 import type { RsbuildConfig } from '@rsbuild/core';
 import type { RsbuildPlugin } from '@rsbuild/core';
 import type { ZoomOptions } from 'medium-zoom';
@@ -127,7 +128,7 @@ declare interface DefaultThemeConfig {
      * Whether to redirect to the closest locale when the user visits the site
      * @default 'auto'
      */
-    localeRedirect?: 'auto' | 'never';
+    localeRedirect?: 'auto' | 'never' | 'only-default-lang';
     /**
      * Whether to show the fallback heading title when the heading title is not presented but `frontmatter.title` exists
      * @default true
@@ -274,7 +275,7 @@ declare type LocalSearchOptions = SearchHooks & {
     versioned?: boolean;
     /**
      * If enabled, the search index will include code block content, which allows users to search code blocks.
-     * @default false
+     * @default true
      */
     codeBlocks?: boolean;
 };
@@ -296,13 +297,14 @@ declare interface MarkdownOptions {
      */
     globalComponents?: string[];
     /**
-     * Code highlighter, default is prism for performance reason
+     * @type import('@shikijs/rehype').RehypeShikiOptions
      */
-    codeHighlighter?: 'prism' | 'shiki';
+    shiki?: Partial<PluginShikiOptions>;
     /**
-     * Register prism languages
+     * Speed up build time by caching mdx parsing result in `rspress build`
+     * @default true
      */
-    highlightLanguages?: (string | [string, string])[];
+    crossCompilerCache?: boolean;
 }
 
 declare type Nav = NavItem[] | {
@@ -346,9 +348,8 @@ declare interface Options {
  * and should not be used in the runtime (usePageData).
  */
 declare interface PageIndexInfo {
-    id: number;
-    title: string;
     routePath: string;
+    title: string;
     toc: Header[];
     content: string;
     _flattenContent?: string;
@@ -368,6 +369,8 @@ declare type PageType = 'home' | 'doc' | 'custom' | '404' | 'blank';
  */
 export declare function pluginMediumZoom(options?: Options): RspressPlugin;
 
+declare type PluginShikiOptions = RehypeShikiOptions;
+
 declare type RemoteSearchIndexInfo = string | {
     value: string;
     label: string;
@@ -466,6 +469,7 @@ declare interface RspressPlugin {
     addPages?: (config: UserConfig, isProd: boolean) => AdditionalPage[] | Promise<AdditionalPage[]>;
     /**
      * Add runtime modules
+     * @deprecated use [rsbuild-plugin-virtual-module](https://github.com/rspack-contrib/rsbuild-plugin-virtual-module) instead.
      */
     addRuntimeModules?: (config: UserConfig, isProd: boolean) => Record<string, string> | Promise<Record<string, string>>;
     /**
@@ -512,7 +516,7 @@ declare interface SidebarGroup {
     text: string;
     link?: string;
     tag?: string;
-    items: (SidebarItem | SidebarDivider | SidebarGroup | string)[];
+    items: (SidebarGroup | SidebarItem | SidebarDivider | SidebarSectionHeader)[];
     collapsible?: boolean;
     collapsed?: boolean;
     /**
@@ -576,7 +580,7 @@ declare interface UserConfig<ThemeConfig = DefaultThemeConfig> {
     /**
      * Path to html icon file.
      */
-    icon?: string;
+    icon?: string | URL;
     /**
      * Default language of the site.
      */

package/dist/index.js

@@ -1,5 +1,5 @@
-import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
-import * as __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__ from "node:url";
+import node_path from "node:path";
+import { fileURLToPath } from "node:url";
 function slash(str) {
     return str.replace(/\\/g, '/');
 }
@@ -18,12 +18,12 @@ function normalizePosixPath(id) {
     return normalizedPath;
 }
 function pluginMediumZoom(options = {}) {
-    const __dirname = normalizePosixPath(__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].dirname((0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.fileURLToPath)(import.meta.url)));
+    const __dirname = normalizePosixPath(node_path.dirname(fileURLToPath(import.meta.url)));
     return {
         name: '@rspress/plugin-medium-zoom',
         globalUIComponents: [
             [
-                __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(__dirname, '../static/MediumZoom.tsx'),
+                node_path.join(__dirname, '../static/MediumZoom.tsx'),
                 options
             ]
         ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-medium-zoom",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.20",
   "description": "A plugin for rspress to zoom images in docs.",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -32,19 +32,19 @@
     "medium-zoom": "1.1.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.4",
-    "@rslib/core": "0.6.5",
-    "@types/node": "^18.11.17",
-    "@types/react": "^18.3.20",
-    "@types/react-dom": "^18.3.6",
+    "@microsoft/api-extractor": "^7.52.8",
+    "@rslib/core": "0.10.4",
+    "@types/node": "^22.8.1",
+    "@types/react": "^19.1.8",
+    "@types/react-dom": "^19.1.6",
     "react": "^19.1.0",
-    "rsbuild-plugin-publint": "^0.3.0",
+    "rsbuild-plugin-publint": "^0.3.2",
     "typescript": "^5.8.2",
     "@rspress/config": "1.0.0",
-    "@rspress/shared": "2.0.0-beta.2"
+    "@rspress/shared": "2.0.0-beta.20"
   },
   "peerDependencies": {
-    "@rspress/runtime": "^2.0.0-beta.2"
+    "@rspress/runtime": "^2.0.0-beta.20"
   },
   "engines": {
     "node": ">=18.0.0"