mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
756d730c40
* docs: document searchable frontmatter for per-page search opt-out * docs: tighten sentence length in searchable usage guidance * docs: clarify searchable:false also excludes AI assistant context * docs: tighten searchable ResponseField sentence length --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
107 lines
4.0 KiB
Plaintext
107 lines
4.0 KiB
Plaintext
---
|
|
title: "Search"
|
|
description: "Configure the in-product search bar on your Mintlify documentation site, including ranking boosts and the number of results returned per query."
|
|
keywords: ["search", "search ranking", "search boost", "boost", "search prioritization", "maximum search results", "max results", "searchable", "exclude from search"]
|
|
---
|
|
|
|
Configure how the search bar on your Mintlify-hosted documentation site behaves. These settings only affect in-product search. They do not change how external search engines index your pages.
|
|
|
|
## Boost search ranking
|
|
|
|
Use `boost` to bias the in-product search ranking of specific pages or sections. The value is a numeric multiplier applied to each chunk's relevance score: `boost: 3` makes a chunk three times as relevant as it would be without a boost.
|
|
|
|
### Boost a single page
|
|
|
|
Set `boost` in a page's [frontmatter](/organize/pages) to multiply its search ranking.
|
|
|
|
```mdx
|
|
---
|
|
title: "Custom domain"
|
|
description: "Connect your custom domain to your Mintlify documentation."
|
|
boost: 3
|
|
---
|
|
```
|
|
|
|
### Boost a navigation group
|
|
|
|
Set `boost` on a group in your `docs.json` navigation to apply the multiplier to every page under it.
|
|
|
|
```json
|
|
{
|
|
"navigation": {
|
|
"groups": [
|
|
{
|
|
"group": "Get started",
|
|
"boost": 5,
|
|
"pages": [
|
|
"quickstart",
|
|
"concepts"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
A page inherits the boost factor from its nearest ancestor that sets one. A child page or nested group can override the inherited boost by setting its own `boost` value. A page's frontmatter `boost` always wins over a value inherited from the navigation.
|
|
|
|
### De-prioritize content
|
|
|
|
Use a value below `1` to push pages further down in search results. For example, `boost: 0.5` halves a page's relevance score relative to other pages. A `boost` of `1` is equivalent to no boost.
|
|
|
|
```mdx
|
|
---
|
|
title: "Deprecated API"
|
|
description: "Documentation for the deprecated v1 API."
|
|
boost: 0.25
|
|
---
|
|
```
|
|
|
|
<Note>
|
|
Boost factors compose with the existing relevance score. Use them sparingly. Large multipliers can cause less-relevant pages to dominate search results and degrade overall search quality.
|
|
</Note>
|
|
|
|
## Exclude a page from search
|
|
|
|
Set `searchable: false` in a page's [frontmatter](/organize/pages) to exclude it from your documentation site's search results.
|
|
|
|
```mdx
|
|
---
|
|
title: "Internal notes"
|
|
description: "Reference material we don't want surfacing in search."
|
|
searchable: false
|
|
---
|
|
```
|
|
|
|
Unlike `noindex`, `searchable: false` doesn't affect external SEO. The page is still:
|
|
|
|
- Crawlable by external search engines
|
|
- Listed in your `sitemap.xml`
|
|
|
|
It's removed from your documentation site's search results and the AI assistant context.
|
|
|
|
Use `searchable: false` for pages that should stay reachable through direct links or external search engines but shouldn't surface when users search inside your docs. Examples include deep reference pages, legacy content, and supporting material that would otherwise crowd out more relevant results.
|
|
|
|
To exclude a page from both in-product search and external indexing, use [`noindex: true`](/optimize/seo#disable-indexing) instead.
|
|
|
|
## Maximum search results
|
|
|
|
Control how many results the search bar returns per query from your dashboard. The default is `6` results. You can set any value between `1` and `100`.
|
|
|
|
In your dashboard, navigate to **Settings** > **Deployment** > **Search**, set **Maximum search results** to the value you want, and select **Save changes**.
|
|
|
|
<Frame>
|
|
<img
|
|
alt="The Search settings page in the dashboard with the Maximum search results stepper set to 6."
|
|
className="block dark:hidden"
|
|
src="/images/search-settings-light.png"
|
|
/>
|
|
<img
|
|
alt="The Search settings page in the dashboard with the Maximum search results stepper set to 6."
|
|
className="hidden dark:block"
|
|
src="/images/search-settings-dark.png"
|
|
/>
|
|
</Frame>
|
|
|
|
Higher values surface more matches per query, which is useful for sites with broad topic coverage where users expect to scan many candidates. Lower values keep the results panel compact and push users toward the top-ranked match.
|