import { ComponentMeta } from '../ComponentMeta'; import { PluginBuilder, PluginFs } from '../Plugin'; export interface MarkdownPluginConfig extends Record { outputPath(component: ComponentMeta, fs: PluginFs): Promise; transformContent(component: ComponentMeta, content: string): Promise; } export declare const MARKDOWN_PLUGIN_DEFAULT_CONFIG: MarkdownPluginConfig; export declare function normalizeMarkdownPluginConfig(config: Partial): Promise; /** * Transforms component metadata into markdown (`.md`) files. By default each markdown file will be * output in the directory the component was declared in, feel free to change this * via the config options. This will run in the `transform` plugin lifecycle step. * * @option outputPath - Receives each `ComponentMeta` and it should return the path to where it's * respective markdown file should be output. * @option transformContent - Receives each `ComponentMeta` and the new markdown content as a * `string` and returns the transformed content. * * @example * ```ts * // wcom.config.ts * * import { markdownPlugin } from '@wcom/cli'; * * export default [ * markdownPlugin({ * // Configuration options here. * async outputPath(component, fs) { * return fs.resolvePath(component.source.dirPath, 'README.md'); * }, * }), * ]; * ``` */ export declare const markdownPlugin: PluginBuilder>; //# sourceMappingURL=index.d.ts.map