tsdoc-markdown/dist/types/parser/markdown.d.ts

Generates markdown documentation from TypeScript source code.

import type { DocEntry, MarkdownOptions } from '../types';
/**
 * Convert the documentation entries to an opinionated Markdown format.
 *
 * @param {entries: DocEntry[]; options: MarkdownOptions;} params
 * @param params.entries The entries of the documentation (functions, constants and classes).
 * @param params.options Optional configuration to render the Markdown content. See `types.ts` for details.
 */
export declare const documentationToMarkdown: ({ entries, options }: {
    entries: DocEntry[];
    options?: MarkdownOptions | undefined;
}) => string;