@modern-js/plugin-rspress/dist/index.d.ts

A Modern.js plugin to integrate rspress

import type { CliPlugin } from '@modern-js/module-tools';
import type { ModuleTools } from '@modern-js/module-tools';
import type { Options } from '@rspress/plugin-preview';
import type { PluginOptions as PluginOptions_2 } from '@rspress/plugin-api-docgen';
import type { UserConfig } from '@rspress/core';

/**
 * @deprecated
 */
declare type DeprecatedMode = 'mobile' | 'web';

declare type ExtraOptions = {
    /**
     * Target language
     * @deprecated Please use https://rspress.dev/guide/default-theme/i18n.html
     */
    languages?: Array<ModuleDocgenLanguage>;
    /**
     * set it true to use module default sidebar, or customize the sidebar with false value
     * @deprecated Please see https://rspress.dev/guide/basic/auto-nav-sidebar.html
     */
    useModuleSidebar?: boolean;
    /**
     * Doc framework config
     */
    doc?: UserConfig;
    /**
     * previewMode
     * @default 'internal'
     */
    previewMode?: DeprecatedMode | 'internal' | 'iframe';
};

/**
 * @deprecated
 */
declare type ModuleDocgenLanguage = 'zh' | 'en';

declare const modulePluginDoc: (pluginOptions?: PluginOptions) => CliPlugin<ModuleTools>;
export default modulePluginDoc;
export { modulePluginDoc }

export declare type PluginOptions = PluginOptions_2 & Omit<Options, 'previewMode'> & ExtraOptions;

export { }