fix: use Mintlify dynamic thumbnails for API reference OG images#227
Merged
patcapulong merged 3 commits intomainfrom Feb 25, 2026
Merged
fix: use Mintlify dynamic thumbnails for API reference OG images#227patcapulong merged 3 commits intomainfrom
patcapulong merged 3 commits intomainfrom
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Auto-generated OpenAPI pages were showing a blank background as their OG image because seo.metatags.og:image bypassed Mintlify's dynamic thumbnail generation. Switch to the thumbnails config so these pages get dynamically generated OG images with page titles overlaid on a dark background. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Greptile SummarySwitches auto-generated OpenAPI API reference pages from a static, blank OG fallback image to Mintlify's dynamic thumbnail system, which overlays the page title and logo onto a dark background. Manually authored pages retain their per-page
Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| mintlify/docs.json | Replaces static seo.metatags.og:image (which bypassed Mintlify's dynamic thumbnail generation) with the thumbnails config block. The empty seo: {} is left behind as a no-op placeholder. Per-page og:image frontmatter overrides on manually authored pages are unaffected. |
| mintlify/images/og/og-api-reference-generic.png | New dark-themed background image (dotted pattern on dark background) used by the thumbnails config for Mintlify's dynamic OG image generation. Appropriate dimensions for OG images. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Page Request] --> B{Has per-page<br/>og:image frontmatter?}
B -->|Yes| C[Use per-page OG image<br/>e.g. og-ramps.png, og-api-reference.png]
B -->|No| D{thumbnails config<br/>in docs.json?}
D -->|Yes - NEW| E[Mintlify dynamic thumbnail<br/>Page title + logo on<br/>og-api-reference-generic.png]
D -->|No - OLD| F[Static og-fallback-bg.png<br/>Blank dotted background]
style E fill:#2d6a4f,stroke:#1b4332,color:#fff
style F fill:#6c757d,stroke:#495057,color:#fff
Last reviewed commit: 51df43a
Contributor
Author
bsiaotickchong
approved these changes
Feb 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Summary
seo.metatags.og:imageindocs.jsonwas set to the rawog-fallback-bg.png, which bypasses Mintlify's dynamic thumbnail generationog:imagemeta tag override with Mintlify'sthumbnailsconfig, which dynamically generates OG images by overlaying the page title and logo on a dark backgroundog:imagefrontmatter overridesTest plan
/api-reference/external-accounts/add-a-new-external-account) -- verify the OG image now shows the page title with light text on the dark backgroundog:image(e.g./api-reference/authentication) still shows the pre-bakedog-api-reference.png/ramps/quickstart) still shows its section-specific OG imageMade with Cursor
Mintlify
0 threads from 0 users in Mintlify