Document search-metadata frontmatter key - #6788
Draft
fern-api[bot] wants to merge 1 commit into
Draft
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ``` | ||
|
|
||
| <Note> | ||
| `search-metadata` values are indexed in Algolia but are **not** displayed in Fern's built-in search UI. They are intended for use in custom Algolia integrations. To surface them as visible filters in your own search experience, use Algolia's InstantSearch widgets or API directly. See [Integrating with Algolia](#integrating-with-algolia) for how to obtain your credentials. |
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'they're' instead of 'They are'.
Suggested change
| `search-metadata` values are indexed in Algolia but are **not** displayed in Fern's built-in search UI. They are intended for use in custom Algolia integrations. To surface them as visible filters in your own search experience, use Algolia's InstantSearch widgets or API directly. See [Integrating with Algolia](#integrating-with-algolia) for how to obtain your credentials. | |
| `search-metadata` values are indexed in Algolia but are **not** displayed in Fern's built-in search UI. they're intended for use in custom Algolia integrations. To surface them as visible filters in your own search experience, use Algolia's InstantSearch widgets or API directly. See [Integrating with Algolia](#integrating-with-algolia) for how to obtain your credentials. |
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-08-31-fern-ai-fe3932-72e70676.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a "Custom search metadata" section to the Search configuration page, placed after "How search works" and its subsections and before "How results are ranked". It explains how to attach
search-metadatakey-value pairs in page frontmatter, shows single- and multi-value YAML examples, covers using the resulting attributes as Algolia facets and filters (including InstantSearch), and notes in a callout that the values are indexed but not shown in Fern's built-in search UI. Also added a "Search metadata" subsection at the end of the Page settings frontmatter reference with a<ParamField>forsearch-metadata, a frontmatter example, and a link to the new search page section.