/** * Awesome-list README generator. * * Produces a deterministic markdown README in the canonical * sindresorhus/awesome format: an H1, the Awesome badge, a Contents * TOC, H2 category sections, and `- [Name](URL) - Description.` entries * sorted alphabetically within each section. * * The output is wrapped between `` / * `` sentinels so a project's hand-written * intro, contributing notes, and license section are preserved across * regenerations. When the sentinels are absent, a new block is appended. */ export interface AwesomeReadmeRecord { slug: string; name?: string | undefined; description?: string | undefined; category?: string | undefined; repoUrl?: string | undefined; homepageUrl?: string | undefined; stars?: number | undefined; license?: string | undefined; visibility?: string | undefined; } export interface AwesomeReadmeCategory { id: string; name: string; } export interface AwesomeReadmeOptions { title?: string | undefined; tagline?: string | undefined; description?: string | undefined; url?: string | undefined; browseLabel?: string | undefined; intro?: string | undefined; showBadge?: boolean | undefined; showToc?: boolean | undefined; showBrowseLink?: boolean | undefined; } export interface AwesomeReadmeInput { site: { name: string; tagline?: string | undefined; description?: string | undefined; url?: string | undefined; repoUrl?: string | undefined; }; records: AwesomeReadmeRecord[]; categories: AwesomeReadmeCategory[]; generatedAt: string; readme?: AwesomeReadmeOptions | undefined; } export declare const AWESOME_README_START = ""; export declare const AWESOME_README_END = ""; export declare function buildAwesomeReadme(input: AwesomeReadmeInput): string; export interface AwesomeReadmeSections { before: string; entries: string; after: string; } export declare function parseAwesomeReadmeSections(readme: string): AwesomeReadmeSections; export declare function injectAwesomeReadmeBlock(readme: string, block: string): string; //# sourceMappingURL=awesome-readme.d.ts.map