From eafce6596b9e236499d67aea2cc098c836aeaaa2 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 7 Oct 2026 20:47:31 +0000 Subject: [PATCH] docs: document local OG image preview in mint dev --- optimize/seo.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/optimize/seo.mdx b/optimize/seo.mdx index f58f104a9d..53159842d3 100644 --- a/optimize/seo.mdx +++ b/optimize/seo.mdx @@ -137,6 +137,17 @@ description: "Your page description" Setting `og:image` in meta tags, globally or per-page, replaces the auto-generated social preview with a static image. If you want Mintlify to automatically overlay your logo, page title, and description on a custom background, use [`thumbnails.background`](/organize/settings-appearance#param-thumbnails-background) instead. +### Preview OG images locally + +When you run [`mint dev`](/cli/preview), the local preview generates the OG image for each page from your local files. Open `/_mintlify/og/.png` in your browser to see the image for a page. Use `index.png` for your home page. + +```text Example preview URLs +http://localhost:3000/_mintlify/og/guides/webhooks.png +http://localhost:3000/_mintlify/og/index.png +``` + +The image regenerates on every request, so refresh the browser to see changes to your `docs.json`, page frontmatter, or logo. Each page's `og:image` meta tag in the local preview points to its generated image, unless you set a custom `og:image`. + ## Global meta tags To set default meta tags for all pages, add the `metatags` field to your `docs.json`.