Skip to content

feat(website): social preview images and Open Graph tags for every page - #12

Merged
arg1998 merged 1 commit into
mainfrom
feat/website-og-images
Sep 17, 2026
Merged

arg1998 merged 1 commit into
mainfrom
feat/website-og-images

Conversation

@arg1998

@arg1998 arg1998 commented Sep 17, 2026

Copy link
Copy Markdown
Owner

What

  • Preview images: a 1200×630 PNG for the landing page (/og/home.png) and one for every docs page (/og/docs/guide/vault.png, …), rendered at build time with satori and resvg. They use the site's fonts and honeycomb theme and show the section, title, description, docs version and URL. When a new docs page is added, its image is generated automatically.
  • Tags: the landing page and all docs pages, including the 404, get og:image (plus secure_url, type, width, height, alt), twitter:card=summary_large_image, and twitter:title, twitter:description, twitter:image. Docs pages also get article:modified_time. Starlight already emits og:title, og:description, og:url and og:type.
  • Caching: /og/* is served with a one-day cache.
  • Fix: generated page descriptions no longer drop underscores inside identifiers (request_attention came out as requestattention). Test added.

Verified

  • bun run website:check and astro build pass. The build produces 22 images.
  • Checked the emitted tags in the built HTML for the landing page, the docs index, a guide page and the 404.
  • Looked at the rendered cards for the landing page, docs index, a guide page and the tool reference.

A 1200x630 card per docs page and one for the landing page, rendered at build
time with satori and resvg in the site's fonts and colors. Pages get og:image
with size and alt text, twitter:card summary_large_image, twitter title,
description and image, and article:modified_time on docs.

Also keeps underscores inside identifiers in generated page descriptions
(request_attention was rendered as requestattention).
@arg1998
arg1998 enabled auto-merge (squash) September 17, 2026 02:49
@arg1998
arg1998 merged commit 74f9ba6 into main Sep 17, 2026
20 checks passed
@arg1998
arg1998 deleted the feat/website-og-images branch September 17, 2026 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant