package-release

Package release OG image template

Package name, a version tag, the install command in a terminal pill and downloads, licence and size.

Package release Open Graph image template rendered by Shareglint
Package release template at square size (1080×1080)
Package release template at portrait size (1080×1350)
Package release template at story size (1080×1920)
Package release template at pinterest size (1000×1500)
Package release template at youtube size (1280×720)

These are real renders from the API with the example values in the table below. Switch the size above: the same template lays itself out for all 6 sizes — send size or sizes with the request.

For npm, PyPI, Composer and crates releases. The install command is the one line people copy, so it gets the dark pill; the version hangs on a tag and grows into the centrepiece on square and vertical formats.

Fields

Every field is optional. Long text shrinks to fit instead of overflowing; an image field takes a public URL that we fetch on our side.

Field Type Description Example
package text Package name, e.g. @northwind/og-kit. default: package-name @northwind/og-kit
version text Version, e.g. v3.0.0. v3.0.0
description text One or two sentences under the title. Typed helpers for Open Graph images at build time and on the edge.
install text Install command, e.g. npm install @northwind/og-kit. npm install @northwind/og-kit
downloads text Download count, e.g. 1.2M weekly downloads. 1.2M weekly downloads
license text Licence, e.g. MIT. MIT
bundle_size text Size, e.g. 4.1 kB gzipped. 4.1 kB gzipped
registry text Registry name next to the logo, e.g. npm. npm
site text Your domain or a short URL. northwind.dev/og-kit
logo image URL Logo image. https://example.com/images/logo-northwind.png
accent colour Brand colour as hex, e.g. #6366f1. Drives buttons, highlights and the background glow. default: #e11d48 #e11d48
theme dark | light Colour scheme: dark or light. —

Render it with one request

Use the slug as template. The response holds the URL of the finished PNG; ?wait=true keeps the connection open until it is ready.

curl -X POST "https://shareglint.com/v1/images?wait=true" \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "package-release",
    "modifications": {
        "package": "@northwind/og-kit",
        "version": "v3.0.0",
        "description": "Typed helpers for Open Graph images at build time and on the edge.",
        "install": "npm install @northwind/og-kit",
        "downloads": "1.2M weekly downloads",
        "license": "MIT",
        "bundle_size": "4.1 kB gzipped",
        "registry": "npm",
        "site": "northwind.dev/og-kit",
        "logo": "https://example.com/images/logo-northwind.png"
    }
}'

Or paste a signed URL into og:image

For static sites, Webflow, Shopify and no-code tools: put the fields in the query string and sign it with your signing secret. The first request renders the image, every later one is a redirect to the cached file. How to compute the signature.

<meta property="og:image" content="https://shareglint.com/i/acc_YOUR_ACCOUNT_ID/package-release.png?bundle_size=4.1%20kB%20gzipped&description=Typed%20helpers%20for%20Open%20Graph%20images%20at%20build%20time%20and%20on%20the%20edge.&downloads=1.2M%20weekly%20downloads&install=npm%20install%20%40northwind%2Fog-kit&license=MIT&package=%40northwind%2Fog-kit&registry=npm&site=northwind.dev%2Fog-kit&version=v3.0.0&s=YOUR_SIGNATURE">

Make it yours

accent and theme change per request. For anything more, copy the template into your account: you get an ordinary HTML template with the same fields that you can edit in the dashboard or through the API. If the slug is free on your account, the copy takes it — your integrations switch to your version without changing a line.

curl -X POST "https://shareglint.com/v1/templates/library/package-release/copy" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

More OG image templates

All templates →