/**
 * Describes the options declared by the plugin.
 */
export interface PluginOptions {
    /**
     * Custom anchor prefix to add to anchor links.
     */
    anchorPrefix?: string;
    /**
     * Specifies comment block tags that should preserve their position.
     */
    blockTagsPreserveOrder?: string[];
    /**
     * Sets the format of property groups for classes.
     */
    classPropertiesFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * The format of custom anchors.
     */
    customAnchorsFormat?: 'curlyBrace' | 'escapedCurlyBrace' | 'squareBracket';
    /**
     * The file name of the entry page.
     */
    entryFileName?: string;
    /**
     * @deprecated This functionality has been deprecated in favour of the @mergeModuleWith tag.
     */
    entryModule?: string;
    /**
     * Sets the format of enumeration members.
     */
    enumMembersFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * @deprecated This option has been renamed hideGroupHeadings to better reflect its purpose.
     */
    excludeGroups?: boolean;
    /**
     * Exclude writing @ scope directories in paths.
     */
    excludeScopesInPaths?: boolean;
    /**
     * Expand objects inside declarations.
     */
    expandObjects?: boolean;
    /**
     * Expand parameters in signature parentheses to display type information.
     */
    expandParameters?: boolean;
    /**
     * Specify the file extension for generated output files.
     */
    fileExtension?: string;
    /**
     * Flatten output files to a single directory.
     */
    flattenOutputFiles?: boolean;
    /**
     * Apply additional output formatting with Prettier.
     */
    formatWithPrettier?: boolean;
    /**
     * Hide the page breadcrumbs.
     */
    hideBreadcrumbs?: boolean;
    /**
     * Excludes grouping by kind so all members are rendered at the same level.
     */
    hideGroupHeadings?: boolean;
    /**
     * Hide the page header.
     */
    hidePageHeader?: boolean;
    /**
     * Hide the page title.
     */
    hidePageTitle?: boolean;
    /**
     * Sets the format of index items.
     */
    indexFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * Sets the format of property groups for interfaces.
     */
    interfacePropertiesFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * Determines which members are exported to their own file.
     */
    membersWithOwnFile?: ('Enum' | 'Variable' | 'Function' | 'Class' | 'Interface' | 'TypeAlias')[];
    /**
     * Appends the documentation index page to the readme page.
     */
    mergeReadme?: boolean;
    /**
     * The file name of the separate modules / index page.
     */
    modulesFileName?: string;
    /**
     * Specifies the file path where the navigation JSON will be written.
     */
    navigationJson?: string;
    /**
     * @deprecated This option has been deprecated in favour of TypeDoc `navigation` option.
     */
    navigationModel?: {
        excludeGroups?: boolean;
        excludeCategories?: boolean;
        excludeFolders?: boolean;
    };
    /**
     * @deprecated Deprecated in favour of `--router`.
     */
    outputFileStrategy?: 'members' | 'modules';
    /**
     * Configure page title output with placeholders.
     */
    pageTitleTemplates?: {
        index?: string | ((name: {
            projectName: string;
            version: string;
        }) => string);
        member?: string | ((name: {
            name: string;
            rawName: string;
            kind: string;
            isDeprecated: boolean;
            group?: string;
            codeKeyword?: string;
            keyword?: string;
        }) => string);
        module?: string | ((name: {
            name: string;
            rawName: string;
            kind: string;
            isDeprecated: boolean;
        }) => string);
    };
    /**
     * Sets the format of parameter and type parameter groups.
     */
    parametersFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * Preserve anchor casing when generating link to symbols.
     */
    preserveAnchorCasing?: boolean;
    /**
     * Specify a custom Prettier configuration file location.
     */
    prettierConfigFile?: string;
    /**
     * @deprecated  This option has been deprecated in favour of `--interfacePropertiesFormat` and `--classPropertiesFormat`.
     */
    propertiesFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * Sets the format of style for property members for interfaces and classes.
     */
    propertyMembersFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * Specify the base path for all urls.
     */
    publicPath?: string;
    /**
     * Sanitize HTML and JSX inside JsDoc comments.
     */
    sanitizeComments?: boolean;
    /**
     * Controls whether to strikethrough page titles of deprecated items.
     */
    strikeDeprecatedPageTitles?: boolean;
    /**
     * Control how table columns are configured and displayed.
     */
    tableColumnSettings?: {
        hideDefaults?: boolean;
        hideInherited?: boolean;
        hideModifiers?: boolean;
        hideOverrides?: boolean;
        hideSources?: boolean;
        hideValues?: boolean;
        leftAlignHeaders?: boolean;
    };
    /**
     * @deprecated This option has been deprecated in favour of `--pageTitleTemplates`.
     */
    textContentMappings?: Record<string, any>;
    /**
     * Sets the format of style for type alias properties.
     */
    typeAliasPropertiesFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * Sets the format of style for type declaration members.
     */
    typeDeclarationFormat?: 'list' | 'table' | 'htmlTable';
    /**
     * Set the visibility level for type declaration documentation.
     */
    typeDeclarationVisibility?: 'compact' | 'verbose';
    /**
     * Wraps signatures and declarations in code blocks.
     */
    useCodeBlocks?: boolean;
    /**
     * Add custom anchors like `{#custom-id}` to headings.
     */
    useCustomAnchors?: boolean;
    /**
     * Add HTML anchors to page headings.
     */
    useHTMLAnchors?: boolean;
    /**
     * Use HTML encoded entities for angle brackets.
     */
    useHTMLEncodedBrackets?: boolean;
}