diff options
| author | Chris Swithinbank | 2025-07-16 13:17:58 +0200 |
|---|---|---|
| committer | GitHub | 2025-07-16 13:17:58 +0200 |
| commit | 3917b206da26522f73bbe0c1120de9acae5972c5 (patch) | |
| tree | 88021612847f7a66bfa9524a1f36418da33a6c6a | |
| parent | 80ccff7c542794e04a4d2abb17227a076fa57c5d (diff) | |
| download | IT.starlight-3917b206da26522f73bbe0c1120de9acae5972c5.tar.gz IT.starlight-3917b206da26522f73bbe0c1120de9acae5972c5.tar.bz2 IT.starlight-3917b206da26522f73bbe0c1120de9acae5972c5.zip | |
Exclude banner content from Pagefind indexing (#3276)
| -rw-r--r-- | .changeset/smooth-pillows-decide.md | 9 | ||||
| -rw-r--r-- | packages/starlight/components/Banner.astro | 2 |
2 files changed, 10 insertions, 1 deletions
diff --git a/.changeset/smooth-pillows-decide.md b/.changeset/smooth-pillows-decide.md new file mode 100644 index 00000000..7cba5f06 --- /dev/null +++ b/.changeset/smooth-pillows-decide.md @@ -0,0 +1,9 @@ +--- +'@astrojs/starlight': minor +--- + +Excludes banner content from search results + +Previously, content set in [`banner`](https://starlight.astro.build/reference/frontmatter/#banner) in page frontmatter was indexed by Starlight’s default search provider Pagefind. This could cause unexpected search results, especially for sites setting a common banner content on multiple pages. Starlight’s default `Banner` component is now excluded from search indexing. + +This change does not impact `Banner` overrides using custom components. diff --git a/packages/starlight/components/Banner.astro b/packages/starlight/components/Banner.astro index 23639b4e..bc1bf063 100644 --- a/packages/starlight/components/Banner.astro +++ b/packages/starlight/components/Banner.astro @@ -2,7 +2,7 @@ const { banner } = Astro.locals.starlightRoute.entry.data; --- -{banner && <div class="sl-banner" set:html={banner.content} />} +{banner && <div class="sl-banner" data-pagefind-ignore set:html={banner.content} />} <style> @layer starlight.core { |