teapub
    Preparing search index...

    Interface RenderOptions

    all options for epub rendering

    interface RenderOptions {
        author?: string;
        copyright?: string;
        css?: string;
        description?: string;
        fonts?: Map<string, Uint8Array<ArrayBufferLike>>;
        frames?: Map<string, string>;
        images?: Map<string, ImageData>;
        lang?: LangCode;
        missingImage?: MissingImage;
        modified?: Date;
        publisher?: string;
        sections: readonly Section[];
        subjects?: readonly string[];
        title: string;
        uid?: string;
    }
    Index

    Properties

    author? copyright? css? description? fonts? frames? images? lang? missingImage? modified? publisher? sections subjects? title uid?

    Properties

    author?: string

    the author

    copyright?: string

    a copyright statement for the epub

    css?: string

    custom global css to apply

    description?: string

    an extra description

    fonts?: Map<string, Uint8Array<ArrayBufferLike>>

    woff2 font files to embed, keyed by filename

    frames?: Map<string, string>

    iframes to include in the epub

    If an iframe tag appears in sections, its src attribute must be present in this map. The value must be an xhtml frame document, unlike sections, this will not be converted to valid xhtml.

    images?: Map<string, ImageData>

    images to include in the epub

    If an img tag appears in sections, its src attribute must be present in this map.

    lang?: LangCode

    the two letter language code (default: "en")

    missingImage?: MissingImage

    how to handle missing images and iframes

    modified?: Date

    the last-modified time recorded as EPUB 3 dcterms:modified metadata

    Defaults to the current time. Pass a fixed Date for byte-reproducible output.

    publisher?: string

    the publisher

    sections: readonly Section[]

    the content of the epub

    subjects?: readonly string[]

    a set of subject tags

    title: string

    the title

    uid?: string

    a unique id for the epub

    If omitted, one will be generated with uuid v4.

    Settings

    Member Visibility

    On This Page

    Properties