-
Notifications
You must be signed in to change notification settings - Fork 207
Adding common metatags #677
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
||
|
|
||
|
|
||
| ## Global meta tags | ||
|
|
||
| You can set default meta tags by adding the `metadata` field to your `docs.json`. | ||
|
|
@@ -65,4 +67,101 @@ | |
| "robots": "noindex" | ||
| } | ||
| } | ||
| ``` | ||
| ``` | ||
|
|
||
| ## Common Meta Tags Reference | ||
|
|
||
| <Accordion title="View all common meta tags"> | ||
| ```json | ||
| "seo": { | ||
| "metatags": { | ||
| "robots": "noindex", | ||
| "charset": "UTF-8", | ||
| "viewport": "width=device-width, initial-scale=1.0", | ||
| "description": "Page description", | ||
| "keywords": "keyword1, keyword2, keyword3", | ||
| "author": "Author Name", | ||
| "robots": "index, follow", | ||
| "googlebot": "index, follow", | ||
| "google": "notranslate", | ||
| "google-site-verification": "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", | ||
| "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> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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