UNPKG

mdat

Version:

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.

github.com/kitschpatrol/mdat

kitschpatrol/mdat

16 lines (15 loc) • 650 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/** * Searches for a readme file in the following order: * 1. Searches the current working directly for readme.md * 2. If there's no readme.md in the current directory, search up to the closest package directory * 3. Give up and return undefined if no readme is found * @returns The path to the readme file or undefined if not found */ export declare function findReadme(): Promise<string | undefined>; /** * Searches up for a readme.md file * @see `findReadme()` for more details on the search process. * @returns The path to the readme file * @throws if no readme is found */ export declare function findReadmeThrows(): Promise<string>;