Skip to content
Merged
Changes from 1 commit
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
101 changes: 100 additions & 1 deletion settings/seo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@

The platform automatically generates most meta tags.

However, you can fully customize them by adding the [metadata](/core-concepts/settings#param-metadata) field to your `docs.json` or the page's frontmatter.

Check warning on line 9 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L9

Did you really mean 'frontmatter'?



## Global meta tags

You can set default meta tags by adding the `metadata` field to your `docs.json`.
Expand Down Expand Up @@ -65,4 +67,101 @@
"robots": "noindex"
}
}
```
```

## Common Meta Tags Reference

<Accordion title="View all common meta tags">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think it makes sense to take it out of the Accordion? Just showcase it proudly?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that totally works, just updated and pushed a new commit

```json
"seo": {

Check warning on line 76 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L76

Did you really mean 'seo'?
"metatags": {

Check warning on line 77 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L77

Did you really mean 'metatags'?
"robots": "noindex",

Check warning on line 78 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L78

Did you really mean 'noindex'?
"charset": "UTF-8",

Check warning on line 79 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L79

Did you really mean 'charset'?
"viewport": "width=device-width, initial-scale=1.0",

Check warning on line 80 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L80

Did you really mean 'viewport'?
"description": "Page description",
"keywords": "keyword1, keyword2, keyword3",
"author": "Author Name",
"robots": "index, follow",
"googlebot": "index, follow",
"google": "notranslate",

Check warning on line 86 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L86

Did you really mean 'notranslate'?
"google-site-verification": "verification_token",

Check warning on line 87 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L87

Did you really mean 'verification_token'?
"generator": "Mintlify",
"theme-color": "#000000",
"color-scheme": "light dark",
"format-detection": "telephone=no",
"referrer": "origin",
"refresh": "30",
"rating": "general",
"revisit-after": "7 days",
"language": "en",
"copyright": "Copyright 2024",
"reply-to": "[email protected]",
"distribution": "global",
"coverage": "Worldwide",
"category": "Technology",
"target": "all",
"HandheldFriendly": "True",
"MobileOptimized": "320",
"apple-mobile-web-app-capable": "yes",
"apple-mobile-web-app-status-bar-style": "black",
"apple-mobile-web-app-title": "App Title",
"application-name": "App Name",
"msapplication-TileColor": "#000000",
"msapplication-TileImage": "path/to/tile.png",
"msapplication-config": "path/to/browserconfig.xml",
"og:title": "Open Graph Title",
"og:type": "website",
"og:url": "https://example.com",
"og:image": "https://example.com/image.jpg",
"og:description": "Open Graph Description",
"og:site_name": "Site Name",
"og:locale": "en_US",
"og:video": "https://example.com/video.mp4",
"og:audio": "https://example.com/audio.mp3",
"twitter:card": "summary",
"twitter:site": "@username",
"twitter:creator": "@username",
"twitter:title": "Twitter Title",
"twitter:description": "Twitter Description",
"twitter:image": "https://example.com/image.jpg",
"twitter:image:alt": "Image Description",
"twitter:player": "https://example.com/player",
"twitter:player:width": "480",
"twitter:player:height": "480",
"twitter:app:name:iphone": "App Name",
"twitter:app:id:iphone": "12345",
"twitter:app:url:iphone": "app://",
"article:published_time": "2024-01-01T00:00:00+00:00",
"article:modified_time": "2024-01-02T00:00:00+00:00",
"article:expiration_time": "2024-12-31T00:00:00+00:00",
"article:author": "Author Name",
"article:section": "Technology",
"article:tag": "tag1, tag2, tag3",
"book:author": "Author Name",
"book:isbn": "1234567890",
"book:release_date": "2024-01-01",
"book:tag": "tag1, tag2, tag3",
"profile:first_name": "John",
"profile:last_name": "Doe",
"profile:username": "johndoe",

Check warning on line 146 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L146

Did you really mean 'johndoe'?
"profile:gender": "male",
"music:duration": "205",
"music:album": "Album Name",
"music:album:disc": "1",
"music:album:track": "1",
"music:musician": "Artist Name",
"music:song": "Song Name",
"music:song:disc": "1",
"music:song:track": "1",
"video:actor": "Actor Name",
"video:actor:role": "Role Name",
"video:director": "Director Name",
"video:writer": "Writer Name",
"video:duration": "120",
"video:release_date": "2024-01-01",
"video:tag": "tag1, tag2, tag3",
"video:series": "Series Name"
}
}
```
</Accordion>