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
"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 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.
"metatags": {
  "og:site_name": "Example Co. Docs",
  "twitter:card": "summary_large_image"
}
docs.json
"seo": {
  "indexing": "navigable",
  "metatags": {
    "og:site_name": "Example Co. Docs"
  }
}
Type: object Search bar display settings.
​
search.prompt
string
Placeholder text displayed in the search bar when it is empty.
docs.json
"search": {
  "prompt": "Search the docs..."
}

​
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
"metadata": {
  "timestamp": true
}

​
Example

docs.json
{
  "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
  }
}