Skip to main content
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 to multiply its search ranking.

​
Boost a navigation group

Set boost on a group in your docs.json navigation to apply the multiplier to every page under it.
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.
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.
boost accepts any positive number. In practice, keep values between 0.1 and 10:
  • 0.1–0.9: de-prioritize legacy, deprecated, or supporting content.
  • 1: no change (equivalent to omitting boost).
  • 2–5: prioritize a key landing page, quickstart, or heavily used reference.
  • 5–10: reserve for a handful of top-level pages that should almost always appear first.
Avoid values greater than 10. Very large multipliers overwhelm the underlying relevance score and cause boosted pages to appear in search results even when they don’t match the query well.

​
Exclude a page from search

Pages are searchable by default. The searchable field is optional and defaults to true. Set searchable: false in a page’s frontmatter to exclude it from your documentation site’s search results. searchable is a page-level field only. To exclude every page under a navigation tab or group, hide the tab or group instead. See Hidden pages for tab- and group-level controls.
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 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. Navigate to the Site settings page in your dashboard. In the “Search” section, set Results per query to your desired value. 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.

​
Result snippets

Enable Result snippets to show a single-line preview of matching content under each search result, in addition to the page title and breadcrumbs. The snippet centers on the first match of the user’s query and highlights the matching terms. When a result has no query match, or the user hasn’t typed a query yet, the snippet falls back to the start of the page’s content. Result snippets help users disambiguate results that share similar titles by showing where the query appears in context. Leave them off if you prefer a more compact results panel. Enable or disable result snippets on the Site settings page in your dashboard. The setting is off by default.

​
Full-page search results

Enable Full-page search results to give your site a dedicated search results page at /search. When enabled, the search bar shows a Search for “query” option that opens the results page for the current query. The page shows up to 50 results, 10 per page, and the URL includes the query (for example, /search?q=authentication) so users can bookmark or share it. On sites with multiple languages, each non-default language gets its own results page at /{language}/search, such as /fr/search. Enable or disable full-page search results on the Site settings page in your dashboard. The setting is off by default.
Enabling full-page search results reserves the /search path. If your site already has a page at /search or /{language}/search, the built-in results page replaces it. Move that page to a different path before enabling this setting.
Mintlify excludes the results page from external search engines with noindex.

​
Search filters

Search filters require an Enterprise plan.
Search filters add product and version dropdowns to search results so users can narrow results to a single product or version. Filters are useful for sites that maintain distinct products or versions, where a search query might otherwise return matches across content the user isn’t looking for. Enable or disable search filters on the Site settings page in your dashboard. Which dropdowns appear depends on your navigation configuration.
  • The product filter appears when your navigation defines more than one product.
  • The version filter appears when your navigation defines versions.
If your navigation has neither products nor versions, enabling search filters has no visible effect.