import type { Preset } from '.'; /** * Use a test file to generate library usage documentation. * * Note: this has been tested with vitest and jest. It _might_ also work fine with mocha, and maybe ava, but those haven't been tested. * * JSDoc/inline comments above tests will be added as a "preamble", making this a decent way to quickly document API usage of a library, * and to be sure that the usage is real and accurate. * * ##### Example * * `` * * @param source the test file * @param include if defined, only tests with titles matching one of these regexes will be included * @param exclude if defined, tests with titles matching one of these regexes will be excluded * @param headerLevel The number of `#` characters to prefix each title with * @param includeEslintDisableDirectives If true, `// eslint-disable ...` type comments will be included in the preamble. @default false */ export declare const markdownFromTests: Preset<{ source: string; headerLevel?: number; include?: string[]; exclude?: string[]; includeEslintDisableDirectives?: boolean; }>;