Skip to main content
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.
docs.json

​
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 your docs.json navigation. Defaults to this value.
  • all — Index every page in your project, including pages not in the navigation.
​
seo.metatags
object
Custom 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.
​
seo.organization
object
The 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 @id URL identifying your organization across pages, for example https://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.
docs.json
Type: object Search bar display settings.
​
search.prompt
string
Placeholder text displayed in the search bar when it is empty.
docs.json

​
metadata

Type: object Page-level metadata settings applied globally across all pages.
​
metadata.timestamp
boolean
Display 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.
docs.json

​
Example

docs.json