vue-docgen-cli/lib/docgen.d.ts

Generate documentation markdown files from VueJs components using the vue-docgen-api.

import { SafeDocgenCLIConfig, Templates, RenderedUsage, DocgenCLIConfig } from './config';
import extractConfig from './extractConfig';
import { header, mdclean } from './compileTemplates';
/**
 * expose default rendering templates so they can be enriched
 */
export declare const defaultTemplates: {
    readonly header: typeof header;
    readonly events: (events: import("vue-inbrowser-compiler-independent-utils").EventDescriptor[], opt?: import("./compileTemplates").SubTemplateOptions) => string;
    readonly methods: (methods: import("vue-inbrowser-compiler-independent-utils").MethodDescriptor[], opt?: import("./compileTemplates").SubTemplateOptions) => string;
    readonly slots: (slots: import("vue-inbrowser-compiler-independent-utils").SlotDescriptor[], opt?: import("./compileTemplates").SubTemplateOptions) => string;
    readonly props: (props: import("vue-inbrowser-compiler-independent-utils").PropDescriptor[], opt?: import("./compileTemplates").SubTemplateOptions) => string;
    readonly component: (renderedUsage: RenderedUsage, doc: import("vue-inbrowser-compiler-independent-utils").ComponentDoc, config: SafeDocgenCLIConfig, fileName: string, requiresMd: import("./compileTemplates").ContentAndDependencies[], { isSubComponent, hasSubComponents }: import("./compileTemplates").SubTemplateOptions) => string;
    readonly expose: (expose: import("vue-inbrowser-compiler-independent-utils").ExposeDescriptor[], opt?: import("./compileTemplates").SubTemplateOptions) => string;
    readonly defaultExample: (doc: import("vue-inbrowser-compiler-independent-utils").ComponentDoc) => string;
    readonly functionalTag: "> functional\n";
    readonly renderTags: (tags?: {
        [tag: string]: (import("vue-inbrowser-compiler-independent-utils").Tag | import("vue-inbrowser-compiler-independent-utils").ParamTag)[];
    } | undefined) => string;
    readonly mdclean: typeof mdclean;
};
export { SafeDocgenCLIConfig as DocgenCLIConfig, Templates, RenderedUsage, extractConfig };
export interface DocgenCLIConfigWithComponents extends SafeDocgenCLIConfig {
    components: string | string[];
}
declare const _default: (config: SafeDocgenCLIConfig) => Promise<void>;
export default _default;
export declare function defineConfig(config: Partial<DocgenCLIConfig>): Partial<DocgenCLIConfig>;