@hrefcl/apidoc - v4.0.5
    Preparing search index...

    Interface MarkdownConfigurationObject

    interface MarkdownConfigurationObject {
        apiDocProjectData: Record<string, any>;
        apiDocApiData: Record<string, any>[];
        template?: string;
        header?: string;
        footer?: string;
        prepend?: string;
        multi?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiDocProjectData: Record<string, any>

    apiDoc project JSON data object (apidoc.json) file content)

    apiDocApiData: Record<string, any>[]

    apiDoc documentation JSON data object (api_data.json file content)

    template?: string

    Name of template to be used (default, bitbucket) or path to EJS template file or raw EJS plain text template (will use default template if omitted).

    header?: string

    Content to add at the top of the documentation

    footer?: string

    Content to add at the bottom of the documentation

    prepend?: string

    Content to add before route groups documentation

    multi?: boolean

    Generate one documentation output per group