mdat/dist/readme/init.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.

type MdatReadmeInitOptions = {
    compound: boolean;
    expand: boolean;
    output: string;
    overwrite: boolean;
    template: string;
};
/**
 * Initializes a new readme file interactively.
 * @returns Path to the created readme file.
 */
export declare function initReadmeInteractive(): Promise<string>;
/**
 * Creates a new readme file with the given options.
 * @returns Path to the created readme file.
 */
export declare function initReadme(options?: Partial<MdatReadmeInitOptions>): Promise<string>;
export {};