SEO

The platform automatically generates most meta tags. However, you can fully customize them by adding the metatags 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.

"seo": {
    "metatags": {
        "og:image": "link to your default meta tag image"
    }
}

Page-specific meta tags

Add your meta tags to the page’s metadata like so:

---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
---

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

Sitemaps

Mintlify automatically generates a sitemap.xml file and a robots.txt file. Simply navigate to /sitemap.xml to see your sitemap. Only pages included in your docs.json are included by default. To include hidden links, add seo.indexing to your docs.json:

"seo": {
    "indexing": all
}

Disabling indexing

If you want to stop a page from being indexed by search engines, you can include the following in the frontmatter of your page:

---
noindex: true
---

You can also specify noindex for all pages in your docs by setting the metadata.robots field to "noindex" in your docs.json:

"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

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. You can preview how your meta tags will appear on different platforms using metatags.io.

"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"
  }
}

Getting started

Core configuration

Components

API pages

Authentication and personalization

Guides

Integrations

Version control and CI/CD

Global meta tags

Page-specific meta tags

Sitemaps

Disabling indexing

Common Meta Tags Reference

​Global meta tags

​Page-specific meta tags

​Sitemaps

​Disabling indexing

​Common Meta Tags Reference

Global meta tags

Page-specific meta tags

Sitemaps

Disabling indexing

Common Meta Tags Reference