Skip to content

added note that absolute filepath is required for og:image #1048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

added note that absolute filepath is required for og:image #1048

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions settings/seo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- Semantic HTML structure
- Mobile optimization

You can fully customize your site's meta tags by adding the `metatags` field to your `docs.json` or a page's frontmatter.

Check warning on line 14 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L14 

Did you really mean 'frontmatter'?

## Global meta tags

Expand All @@ -20,7 +20,7 @@
```json
"seo": {
"metatags": {
"og:image": "link to your default meta tag image"
"og:image": "https://example.com/og-image.jpg"
}
}
```
Expand All @@ -32,14 +32,18 @@
```mdx
---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
'og:image': 'https://example.com/og-image.jpg'
---
```

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

<Note>
`og:image` URLs must be absolute (starting with `https://`) for proper social media sharing.
</Note>

## Common Meta Tags Reference
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.

Expand Down