mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
9d0640aafb
* settings overview page * update docs.json * update links in icons snippets Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * add schema reference * add api settings * add appearance settings * add integrations settings * add seo and search settings * add structure * add new contextual options * update links * Vale --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
116 lines
2.9 KiB
Plaintext
116 lines
2.9 KiB
Plaintext
---
|
|
title: "SEO and search"
|
|
description: "Configure site description, indexing, meta tags, search bar text, and page timestamps in `docs.json`."
|
|
keywords: ["SEO", "search", "indexing", "meta tags", "description", "timestamp", "last modified", "docs.json"]
|
|
---
|
|
|
|
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.
|
|
|
|
```json docs.json
|
|
"description": "Documentation for Example Co.'s API and developer platform."
|
|
```
|
|
|
|
---
|
|
|
|
### `seo`
|
|
|
|
**Type:** `object`
|
|
|
|
Search engine indexing and metadata settings.
|
|
|
|
<ResponseField name="seo.indexing" type='"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.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="seo.metatags" type="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](/optimize/seo#common-meta-tags-reference) for available options.
|
|
|
|
```json
|
|
"metatags": {
|
|
"og:site_name": "Example Co. Docs",
|
|
"twitter:card": "summary_large_image"
|
|
}
|
|
```
|
|
</ResponseField>
|
|
|
|
```json docs.json
|
|
"seo": {
|
|
"indexing": "navigable",
|
|
"metatags": {
|
|
"og:site_name": "Example Co. Docs"
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
### `search`
|
|
|
|
**Type:** `object`
|
|
|
|
Search bar display settings.
|
|
|
|
<ResponseField name="search.prompt" type="string">
|
|
Placeholder text displayed in the search bar when it is empty.
|
|
</ResponseField>
|
|
|
|
```json docs.json
|
|
"search": {
|
|
"prompt": "Search the docs..."
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
### `metadata`
|
|
|
|
**Type:** `object`
|
|
|
|
Page-level metadata settings applied globally across all pages.
|
|
|
|
<ResponseField name="metadata.timestamp" type="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](/organize/pages#last-modified-timestamp) for details.
|
|
</ResponseField>
|
|
|
|
```json docs.json
|
|
"metadata": {
|
|
"timestamp": true
|
|
}
|
|
```
|
|
|
|
## Example
|
|
|
|
```json 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
|
|
}
|
|
}
|
|
```
|