GenerateOgImagesParams

Options for generateOgImages.

Import:

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

Signature:

export interface GenerateOgImagesParams

Properties

Property	Type	Description
brandText	string	The text every card's footer carries, normally the package's name.
contentDocsDirectory	string	The documentation content root, normally <docs>/src/content/docs. Every .md / .mdx page under it with a title gets a card.
faviconPath	string	The SVG logo drawn on every card. A missing file renders the cards without one.
fontsDirectory	string	The folder holding the fonts the cards are rendered with.
outputDirectory	string	The folder the cards are written to, normally <docs>/public/og, served at <base>/og/<slug>.png.

---

Links to this page:

• generateOgImages