vue-docgen-cli
Version:
Generate documentation markdown files from VueJs components using the vue-docgen-api.
7 lines (6 loc) • 541 B
TypeScript
import { ComponentDoc, Tag, ParamTag } from 'vue-docgen-api';
export declare function getExamplesFilePaths(tags: {
[key: string]: (Tag | ParamTag)[];
}, componentDirname: string): string[];
export default function getDocsBlocks(absolutePath: string, doc: Pick<ComponentDoc, 'tags' | 'docsBlocks'>, getDocFileName: (file: string) => string | string[] | false, rootPath: string, editLinkLabel: string, getRepoEditUrl?: (path: string) => string): Promise<string[]>;
export declare function isParamTag(tag: ParamTag | Tag): tag is ParamTag;