Add Pagefind weight frontmatter

[lorenzolewis]

Description

• Closes Ability to adjust pagefind search result weighting on a page level #2348
• Create a pagefind.weight property for page frontmatter to adjust the search index weight
• Add a new set of E2E tests for ensuring the pagefind data attributes are in the build HTML
• Update Site Search guide and front matter reference page with changes

Question

By keeping the weight key required if it's an object for now, we can still add more keys in the future and mark the weight key as optional without any breaking change issues, right? Or would it be better to mark it as "optional" now and handle that additional check in this PR?

[changeset-bot]

🦋 Changeset detected

Latest commit: 820161b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@astrojs/starlight	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[netlify]

✅ Deploy Preview for astro-starlight ready!

Name	Link
🔨 Latest commit	820161b
🔍 Latest deploy log	https://app.netlify.com/sites/astro-starlight/deploys/66ec3e159eb49b00082ae0d4
😎 Deploy Preview	https://deploy-preview-2371--astro-starlight.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (no change from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[astrobot-houston]

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale	File	Note
en	guides/site-search.mdx	Source changed, localizations will be marked as outdated.
en	reference/frontmatter.md	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

[astrobot-houston]

size-limit report 📦

Path	Size
/index.html	6.15 KB (0%)
/_astro/*.js	22.36 KB (-0.02% 🔽)
/_astro/*.css	13.72 KB (0%)

[ematipico]

It would be nice to explain to users when they should change the ranking, and why. The docs of pagefind only explain some technical stuff, but from the point of view of a maintainer like myself, it would be nice to have some guidance on why I should use it.

[lorenzolewis]

Suggested change

	## Adjust ranking in search results
	Pagefind's index ranking can be adjusted using the [`data-pagefind-weight`](https://pagefind.app/docs/weighting/#ranking-content-higher-or-lower) attribute. This can be used to [adjust a whole page](#adjust-whole-page-rank) or [individual sections of a page](#adjust-individual-section-rank).
	Learn more about about how the weight value impacts search results in the [Pagefind Weighting content guide](https://pagefind.app/docs/weighting/).
	## Adjust ranking in search results
	Pagefind's index ranking can be adjusted using the [`data-pagefind-weight`](https://pagefind.app/docs/weighting/#ranking-content-higher-or-lower) attribute. This can be used to [adjust a whole page](#adjust-whole-page-rank) or [individual sections of a page](#adjust-individual-section-rank).
	For example, if there is a high-level guide that is a better entry point for readers than an error reference page containing similar keywords, increasing the weight of the guide page will cause it to be ranked higher in the Pagefind search results.
	Learn more about about how the weight value impacts search results in the [Pagefind Weighting content guide](https://pagefind.app/docs/weighting/).

@ematipico Thanks! Do you think this gives a good example of the usage here? Happy for any suggestions if anything else comes to mind 🥳

[ematipico]

We're getting somewhere I think. Now we should explain when to increase the page weight and when decrease the page weight.