New guide
Announce a Framework Rewrite
Major version drop? The docs home card should carry the new tagline the day the migration guide publishes.
Generate Docs Site Cards in the Stripe Cadence
Reference, quickstart and conceptual pages each deserve a unique unfurl — endpoint crumb, section title and a code sample per URL, in the visual grammar Stripe and Supabase set
Docs site · Oginify1200 × 630 · og:image
API reference pages
An API reference page shared in a dev Slack is what turns a lurker into a user. Oginify pulls the endpoint path, HTTP method and one-line description straight from your reference, then renders a dark-mode card with a green GET/POST badge — the shared link reads like a code block, not a marketing page.
Quickstart & tutorials
Quickstarts get shared as this is how you actually start — the goal is to signal 3 steps, 3 minutes at unfurl time. Oginify renders a numbered-step card with a terminal snippet inline, so the preview earns the click by showing the shape of the tutorial before the click.
Conceptual guides
Conceptual guides — Responsive design, How auth works — are the SEO backbone of a docs site. Oginify renders a light-mode article card with H1 + diagram thumbnail, so the guide looks canonical when it shows up on Google image cards and in dev newsletters.
Changelog entries
Every changelog entry is a mini launch — v2.14 gets shared in a company Slack, in this week in dev newsletters, on Twitter. Oginify renders a versioned card with the release title, date and a screenshot of the shipped feature — the exact anatomy Linear, Supabase and Vercel use for their changelog OGs.
Where a Docs Site Card Ends the Which-Version Question
Standalone docs sites get pasted into onboarding channels and API threads. The card should preview the section, not the wordmark.
Section-aware
Vary Cards by Guide, Tutorial, API
One card style for concepts, another for reference — the reader can tell where the link goes before clicking.
Support
Make Support Links Preview Cleanly
When support pastes a page, the card previews the page name — Rate limits, Authentication — not just Docs.
Build hook
Generate at MDX Build
Docs platforms compiling MDX at deploy call the endpoint per route so every page ships with its section-aware card baked in.
How to Cover a Docs Site with OG Cards
A docs site fanned out across 400 routes shares badly by default — every share collapses to one image. Fix it with per-route generation keyed to H1.
- Step 1
Key each card by H1 and section
The card ID is the concatenation of section slug and page slug; every route gets its own image without human curation.
- Step 2
Render on docs build, not runtime
Emit PNGs into /public/og at build time; runtime rendering slows the crawler and misses cold pages that never get a live visit.
- Step 3
Ship a fallback for search hits
One catch-all card for /docs deep-links older than the current version, so archived pages still preview with the docs brand.
Explore Other Website Types
E-commerce storesSaaS & B2BBlogs & newslettersPortfolios & personal sitesMarketplacesMedia & publicationsEvents & conferences
Docs Site OG FAQ
Answers to what dev-docs teams actually ask before wiring per-page cards into their build.
What Size Should Docs Site OG Images Be?
1200×630 pixels is the universal spec. Every Oginify docs card ships at that resolution — the same size Stripe, Supabase and Vercel use.
Do OG Cards on Docs Pages Actually Improve Adoption?
Yes — a per-endpoint card in a Slack unfurl converts far better than a bare docs.example.com link. The endpoint text in the card IS the pitch.
How Do I Wire OG Generation into My Docs Build Pipeline?
Add a build-step that POSTs each generated docs URL to the Oginify API and writes the returned image URL into the page's og:image meta tag. Runs in CI, one line of glue code per docs framework.
Can I Reuse a Single OG Card for All API Reference Pages?
Technically yes, strategically no. The value of per-endpoint cards is that the endpoint IS visible in the unfurl — reusing one card loses that.
How Do I Handle OG Cards for Dark-Mode vs Light-Mode Docs Sites?
OG images render outside the reader's theme — Slack and LinkedIn always show the image as-is. Pick the theme that matches your docs site's primary aesthetic; Oginify defaults to matching your live site.
Ship an OG Card for Every Endpoint and Changelog Entry
Paste any docs URL and get four 1200×630 Open Graph cards tuned for API reference, quickstarts and changelog. No signup.