SEO and search
Configure SEO settings in docs.json including site description, search engine indexing, meta tags, search bar placeholder, and page timestamps.
Use these settings in your docs.json file to control how search engines index your documentation, what metadata appears in search results, how the search bar behaves, and whether pages display a last-modified timestamp.
Settings
description
Type: string
A description of your documentation site for SEO and AI indexing. This appears in search engine results and AI tools use it to understand your site’s purpose.
"description": "Documentation for Example Co.'s API and developer platform."seo
Type: object
Search engine indexing and metadata settings.
seo.indexing"navigable" | "all"Specifies which pages search engines should index.
navigable— Index only pages included in yourdocs.jsonnavigation. Defaults to this value.all— Index every page in your project, including pages not in the navigation.
seo.metatagsobjectCustom meta tags added to every page. Provide as key-value pairs where each key is a meta tag name and the value is its content.
See common meta tags reference for available options.
"metatags": {
"og:site_name": "Example Co. Docs",
"twitter:card": "summary_large_image"
}seo.organizationobjectThe organization used as the publisher entity in the structured data emitted on every page. All fields are optional. When omitted, Mintlify derives the organization from your site name, docs logo, and site URL.
id— Stable@idURL identifying your organization across pages, for examplehttps://example.com/#organization. Defaults to<site origin>/#organization.name— Organization name. Defaults to the site name.legalName— Registered legal name.url— Canonical organization homepage URL.logo— Canonical logo URL used in structured data. Defaults to the docs logo.sameAs— Array of URLs for official profiles, such as X, LinkedIn, or GitHub.
"organization": {
"id": "https://example.com/#organization",
"legalName": "Example Co. Inc.",
"url": "https://example.com",
"logo": "https://example.com/images/logo.png",
"sameAs": [
"https://x.com/example",
"https://github.com/example"
]
}"seo": {
"indexing": "navigable",
"metatags": {
"og:site_name": "Example Co. Docs"
}
}search
Type: object
Search bar display settings.
search.promptstringPlaceholder text displayed in the search bar when it is empty.
"search": {
"prompt": "Search the docs..."
}metadata
Type: object
Page-level metadata settings applied globally across all pages.
metadata.timestampbooleanDisplay a last-modified date on all pages. When enabled, each page shows the date its content was last modified. Defaults to false.
You can override this setting for individual pages using the timestamp frontmatter field. See Pages for details.
"metadata": {
"timestamp": true
}Example
{
"description": "Documentation for Example Co.'s API and developer platform.",
"seo": {
"indexing": "navigable",
"metatags": {
"og:site_name": "Example Co. Docs",
"twitter:card": "summary_large_image"
}
},
"search": {
"prompt": "Search the docs..."
},
"metadata": {
"timestamp": true
}
}