mdat/dist/readme/config.d.ts

CLI tool and TypeScript library implementing the Markdown Autophagic Template (MDAT) system. MDAT lets you use comments as dynamic content templates in Markdown files, making it easy to generate and update readme boilerplate.

import { type Simplify } from 'type-fest';
import { type ConfigLoaded, loadConfig } from '../config';
type ReadmeConfigLoaded = Simplify<ConfigLoaded & {
    packageFile: string;
}>;
type LoadConfigOptions = Parameters<typeof loadConfig>[0];
/**
 * Convenience loader to always include the default readme config
 */
export declare function loadConfigReadme(options?: LoadConfigOptions): Promise<ReadmeConfigLoaded>;
export {};