Skip to content

Commit 5ad4a63

Browse files
committed
added note that absolute filepath is required for og:image
1 parent 413ab41 commit 5ad4a63

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

settings/seo.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can set default meta tags by adding the `metadata` field to your `docs.json`
2020
```json
2121
"seo": {
2222
"metatags": {
23-
"og:image": "link to your default meta tag image"
23+
"og:image": "https://example.com/og-image.jpg"
2424
}
2525
}
2626
```
@@ -32,14 +32,18 @@ Add your meta tags to the page's metadata like so:
3232
```mdx
3333
---
3434
title: 'Your Example Page Title'
35-
'og:image': 'link to your meta tag image'
35+
'og:image': 'https://example.com/og-image.jpg'
3636
---
3737
```
3838

3939
<Warning>
4040
Meta tags with colons need to be typed with quotes around them when you put them in the page metadata.
4141
</Warning>
4242

43+
<Note>
44+
`og:image` URLs must be absolute (starting with `https://`) for proper social media sharing.
45+
</Note>
46+
4347
## Common Meta Tags Reference
4448
Below is a comprehensive list of meta tags you can add to your `docs.json`. These meta tags help improve your site's SEO, social sharing, and browser compatibility.
4549

0 commit comments

Comments
 (0)