Support multisite search on pagefind

[XREvo]

What version of starlight are you using?

0.31.1

What is your idea?

We are looking to use Starlight in federated mode (aka with one root site on "/" and multile sub-sites on dedicated sub-paths) and we are looking for a way to merge the multiple pagefind index.

Right now, pagefind allow this with mergeIndex options : https://pagefind.app/docs/multisite/

But this option is not provided in the PagefindConfigSchema object.

Why is this feature necessary?

Adding thoses propreties to the PagefindConfigSchema object :

1. a indexWeight proprety to the actual config object
2. an array for mergeIndex next to the ranking property, with the bundlePath and indexWeight sub properties

No need to update the Search.astro component since the config is already spread on the PagefindUI instantiation

Do you have examples of this feature in other projects?

This would be configured like that on the configuration:

export default defineConfig({
  integrations: [
    starlight({
      title: 'My Starlight Site',
      pagefind: {
        indexWeight: 2.0,
        mergeIndex: [{
          bundlePath: "/sub-path-1",
          indexWeight: 0.5
        }, {
          bundlePath: "/sub-path-2",
          indexWeight: 0.75
        }]
      },
    }),
  ],
});

Participation

• I am willing to submit a pull request for this feature.

[delucis]

Hey @XREvo! Sure, this seems reasonable to add to config object I guess if you’re happy to make a PR 👍

[XREvo]

It's in progress: #2858

[XREvo]

Hi @delucis! My PR is ready for review 🚀