SEO

Mintlify automatically generates most meta tags. If you want to customize them, you can set default values in docs.json or change them per page.

Supported Meta Tags

• og:site_name
• og:title
• og:description
• og:url
• og:image
• og:locale
• og:logo
• article:publisher
• twitter:title
• twitter:description
• twitter:url
• twitter:image
• twitter:site
• og:image:width
• og:image:height
• robots

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

Changing Meta Tags on One Page

Add your meta tags to the page’s metadata as follows:

---
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. To view your sitemap, simply add /sitemap.xml to the end of your website URL. We recommend submitting the sitemap to search engines for improved SEO performance.

By default, only pages included in your docs.json are included in the sitemap. To include hidden links, add seo.indexing to your docs.json:

"seo": {
    "indexing": "all"
}

Disabling Indexing

If you want to prevent 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 documentation by setting the metadata.robots field to "noindex" in your docs.json:

"metadata": {
   "robots": "noindex"
}