solidity-docgen/dist/config.d.ts

Documentation generator for Solidity smart contracts.

import type { PageAssigner } from './site';
export interface UserConfig {
    /**
     * The directory where rendered pages will be written.
     * Defaults to 'docs'.
     */
    outputDir?: string;
    /**
     * A directory of custom templates that should take precedence over the
     * theme's templates.
     */
    templates?: string;
    /**
     * The name of the built-in templates that will be used by default.
     * Defaults to 'markdown'.
     */
    theme?: string;
    /**
     * The way documentable items (contracts, functions, custom errors, etc.)
     * will be organized in pages. Built in options are:
     * - 'single': all items in one page
     * - 'items': one page per item
     * - 'files': one page per input Solidity file
     * More customization is possible by defining a function that returns a page
     * path given the AST node for the item and the source unit where it is
     * defined.
     * Defaults to 'single'.
     */
    pages?: 'single' | 'items' | 'files' | PageAssigner;
    /**
     * An array of sources subdirectories that should be excluded from
     * documentation, relative to the contract sources directory.
     */
    exclude?: string[];
    /**
     * Clean up the output by collapsing 3 or more contiguous newlines into only 2.
     * Enabled by default.
     */
    collapseNewlines?: boolean;
    /**
     * The extension for generated pages.
     * Defaults to '.md'.
     */
    pageExtension?: string;
}
export interface Config extends UserConfig {
    /**
     * The root directory relative to which 'outputDir', 'sourcesDir', and
     * 'templates' are specified. Defaults to the working directory.
     */
    root?: string;
    /**
     * The Solidity sources directory.
     */
    sourcesDir?: string;
}
export type FullConfig = Required<Config>;
export declare const defaults: Omit<FullConfig, 'templates'>;
//# sourceMappingURL=config.d.ts.map