@rspress/plugin-preview 0.0.0-canary-20250521

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# @rspress/plugin-preview
+
+> Preview plugin for rspress
+
+[Documentation](https://rspress.dev/plugin/official-plugins/preview)

package/dist/index.d.ts

@@ -0,0 +1,68 @@
+import type { RsbuildConfig } from '@rsbuild/core';
+import { RspressPlugin } from '@rspress/shared';
+
+declare type IframeOptions = {
+    /**
+     * framework in the iframe
+     * @default 'react'
+     */
+    framework?: 'react' | 'solid';
+    /**
+     * position of the iframe
+     * @default 'follow'
+     */
+    position?: 'fixed' | 'follow' | 'fixed-with-per-comp';
+    /**
+     * dev server port for the iframe
+     * @default 7890
+     */
+    devPort?: number;
+    builderConfig?: RsbuildConfig;
+};
+
+export declare type Options = {
+    /**
+     * @deprecated Use previewMode instead.
+     * true = 'iframe'
+     * false = 'internal'
+     */
+    isMobile?: boolean;
+    /**
+     * @deprecated Use iframeOptions.position instead.
+     */
+    iframePosition?: 'fixed' | 'follow';
+    /**
+     * internal mode: component will be rendered inside the documentation, only support react.
+     *
+     * iframe mode: component will be rendered in iframe, note that aside will hide.
+     * @default 'internal'
+     */
+    previewMode?: 'internal' | 'iframe';
+    /**
+     * enable when preview mode is iframe.
+     */
+    iframeOptions?: IframeOptions;
+    /**
+     * determine how to handle a internal code block without meta
+     * @default 'preview'
+     */
+    defaultRenderMode?: 'pure' | 'preview';
+    /**
+     * Supported languages to be previewed
+     */
+    previewLanguages?: string[];
+    /**
+     * Transform previewed code in custom way
+     */
+    previewCodeTransform?: (codeInfo: {
+        language: string;
+        code: string;
+    }) => string;
+};
+
+/**
+ * The plugin is used to preview component.
+ */
+export declare function pluginPreview(options?: Options): RspressPlugin;
+
+export { }