From 5c9a3b2145540c22ebd870d012298db037a9fa6f Mon Sep 17 00:00:00 2001 From: dino475 Date: Tue, 29 Apr 2025 23:12:45 -0700 Subject: [PATCH 1/3] Adding common metatags --- settings/seo.mdx | 101 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 100 insertions(+), 1 deletion(-) diff --git a/settings/seo.mdx b/settings/seo.mdx index 28c42d6b4..2f4579e36 100644 --- a/settings/seo.mdx +++ b/settings/seo.mdx @@ -8,6 +8,8 @@ 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 @@ You can also specify `noindex` for all pages in your docs by setting the `metada "robots": "noindex" } } -``` \ No newline at end of file +``` + +## Common Meta Tags Reference + + +```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@example.com", + "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" + } +} +``` + \ No newline at end of file From 8762ebfe9c80306fa863deb23901f8710ed50a78 Mon Sep 17 00:00:00 2001 From: dino475 Date: Wed, 30 Apr 2025 10:18:45 -0700 Subject: [PATCH 2/3] removed the accordian --- settings/seo.mdx | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/settings/seo.mdx b/settings/seo.mdx index 2f4579e36..fcf5f0981 100644 --- a/settings/seo.mdx +++ b/settings/seo.mdx @@ -70,8 +70,7 @@ You can also specify `noindex` for all pages in your docs by setting the `metada ``` ## Common Meta Tags Reference - - +Add any number of the following meta tags to your `docs.json`: ```json "seo": { "metatags": { @@ -163,5 +162,4 @@ You can also specify `noindex` for all pages in your docs by setting the `metada "video:series": "Series Name" } } -``` - \ No newline at end of file +``` \ No newline at end of file From 65c210fd8782a9c5cafc942cb005907bccf9975e Mon Sep 17 00:00:00 2001 From: dino475 Date: Wed, 30 Apr 2025 11:30:13 -0700 Subject: [PATCH 3/3] added in metatags.io quick fix --- settings/seo.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/settings/seo.mdx b/settings/seo.mdx index fcf5f0981..53a0f8dca 100644 --- a/settings/seo.mdx +++ b/settings/seo.mdx @@ -70,7 +70,10 @@ You can also specify `noindex` for all pages in your docs by setting the `metada ``` ## Common Meta Tags Reference -Add any number of the following meta tags to your `docs.json`: +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. + +You can preview how your meta tags will appear on different platforms using [metatags.io](https://metatags.io/). + ```json "seo": { "metatags": { @@ -162,4 +165,5 @@ Add any number of the following meta tags to your `docs.json`: "video:series": "Series Name" } } -``` \ No newline at end of file +``` +