Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions optimize/seo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Note>

### 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/<page-path>.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`.
Expand Down
Loading