docusaurus-plugin-redoc/dist/options.d.ts

Redoc Plugin for DocusaurusV2

import { Joi } from '@docusaurus/utils-validation';
import type { RawConfig } from '@redocly/openapi-core';
type LayoutProps = {
    title?: string;
    noFooter?: boolean;
    description?: string;
    image?: string;
    keywords?: string[];
    permalink?: string;
    wrapperClassName?: string;
    searchMetadatas?: {
        version?: string;
        tag?: string;
    };
};
/**
 * Can pass only if directly using plugin.
 * `redocusaurus` auto populates them
 */
export interface PluginDirectUsageOptions {
    debug?: boolean;
    themeId?: string;
    /**
     * Redocly config to bundle file
     * @see https://redocly.com/docs/cli/configuration/configuration-file/
     */
    config?: string | RawConfig;
    layout?: LayoutProps;
}
export interface PluginOptions extends PluginDirectUsageOptions {
    id?: string;
    spec: string;
    url?: string;
    route?: string;
    normalizeUrl?: boolean;
}
export interface PluginOptionsWithDefault extends PluginOptions {
    debug: boolean;
}
export declare const DEFAULT_OPTIONS: {
    layout: {};
    debug: false;
    normalizeUrl: true;
};
export declare const PluginOptionSchema: Joi.ObjectSchema<PluginOptions>;
export {};
//# sourceMappingURL=options.d.ts.map