Design system Open Graph Image Template
A design system card with a swatch and component panel and a version chip.
A design system card with a swatch and component panel and a version chip.
Every Open Graph image template is included with Basic and Pro. Pick a plan to copy the code, install with the CLI, and download the raw SVG.
Already purchased? Log in
Use the Design system template for the home of a component library or token set, the card that should look like what it documents. It sets the system name and version beside a panel of color swatches, a button, an input, and a chip row, so the artwork demonstrates the system while it names it.
This template is a metadata image route for the Next.js App Router. The file exports size, contentType, and alt values plus a default async function that returns an ImageResponse. When the docs page is shared, satori converts the JSX into an SVG document, the runtime rasterizes that SVG into a 1200 by 630 PNG, and Next.js serves the result and wires the og:image and twitter:image tags into the page head automatically. The swatches and component skeletons are drawn from divs, so the panel restyles itself the moment you change a color or a radius.
Install with the shadcn CLI using your Shadcn UI Blocks API key:
npx shadcn@latest add @shadcn-ui-blocks/og-image-design-system
The file lands at app/opengraph-image.tsx, which makes it the site wide share card. Move it into the docs segment, for example app/design/opengraph-image.tsx, when the system has its own home. You can also copy the code from this page straight into your project.
The card renders text with Inter, read from assets/fonts at your project root with node:fs so the font files never ship to the browser. Download the latin woff files for weights 400, 500, 600, and 700 from Fontsource and save them as assets/fonts/inter-latin-400-normal.woff and so on.
The content object holds brand, the title that names the system, a subtitle, the description, the version badge, and the url. The swatches array above the template is the palette row; swap in your own token values, keeping the count at six so the row stays even. The button, input, and chip skeletons are drawn inline in the panel, so recolor them to echo your components. Keep the subtitle to one line.
satori supports a focused subset of CSS: flexbox layout only, flat colors, and an explicit display: flex on any element with multiple children. Keep those rules in mind if you rework the layout.