Configurations
Search Engine Optimization
Mintlify automatically generates most meta tags. If you want to customize them, you can set default values in mint.json or change them per page.
Default meta tags
You can set default meta tags by adding the metadata
field to your mint.json
.
"metadata": {
"og:image": "link to your default meta tag image"
}
Changing meta tags on one page
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 add /sitemap.xml
to the end of your website URL to see your sitemap. We recommend submitting the sitemap to search engines for improved SEO.
Only pages included in your mint.json
are included by default. To include hidden links, add seo.indexHiddenPages
to your mint.json
:
"seo": {
"indexHiddenPages": true
}
Was this page helpful?