Templates / Release Note
Release Note social images
Pair a package release with a tidy social image — package name, version, a type badge (feature, fix, breaking), and a one-line summary.
Live preview — edit a field and it re-renders. No key needed.
Signed embed URL (sign it with your key — how)
PARAMETERS
Set it with URL parameters.
Every field below is a query parameter on the image URL. Change a value, get a new image — identical parameters return instantly from cache.
| Parameter | Type | Example |
|---|---|---|
package | text | @acme/ui-kit |
version | text | 3.2.0 |
type | text | minor |
summary | text | Adds dark mode support and fixes accessibility issues in form components. |
EMBED
One tag in your <head>.
Sign the URL with your public key (the docs show how) and drop it in. Crawlers fetch a real image — no build step, no redeploys.