Skip to content

generateOgImages

Generates the Open Graph cards.

A card is re-rendered only when its title, description, signature or badge changed, tracked by a hash manifest beside the cards. A different logo file re-renders every card. Missing content or fonts skip the step with a warning rather than failing the build.

Import:

import { generateOgImages } from '@mnaoumov/typescript-dev-toolkit/docs-site/og-images';

Signature:

function generateOgImages(options: GenerateOgImagesParams): Promise<void>

Parameters:

Parameter Type Description
options GenerateOgImagesParams The options.

Returns: Promise<void>


Links to this page: