Type Alias CoverOptions

Options used to generate a cover image.

type CoverOptions = {
    description: string;
    path: string;
    title: string;
}

Properties

description: string

Description text displayed below the title. New lines (\n) are respected and rendered as separate lines.

path: string

Output path for the generated cover.png (default: the current working directory)

title: string

Main title text displayed on the cover