Improve usuablity of documentation site search

[claremacrae]

Reproduction:

1. Open https://fevol.github.io/obsidian-typings/
2. Enter canvas in the Search box

Result:

You have to click 8 times on 'Load more results' - which gets very old, very quickly.

[claremacrae]

The same usability-of-search issue applies to @mProjectsCode's otherwise-excellent Obsidian Stats - so I suspect it is using the same underlying technology.

[claremacrae]

As well as the scrolling issue, it's not taking advantage of the full width of the screen.

For comparison, this is what the GitHub equivalent search looks like:

[mProjectsCode]

Yes. Those two sites use the same framework. They said that version 0.31.0 of the framework has a better search, but neither site uses that version yet. I also haven't looked at the improvements so idk how major they are.

[Fevol]

Yeah, the search capability could definitely be improved, both stylistically and functionally.
The new Starlight update might indeed improve things, but there also seem to be some configuration options that can be tweaked.
I'll try to get to this sometime soon!

[Fevol]

A short investigation on this issue:

General observations:

• PageFind currently only considers the content for ranking the search, customizing page title ranking is not supported (Discord Message in the Astro server)
• If you are looking for specific Canvas functionality, adding more search term information would always help

Altering the page size:

• The search component itself is provided by a PageFind Svelte component and not Astro (though it is initialized here).
• Dynamically loading new results when scrolling to the bottom is not implemented, so only the 'Load more' option is possible
• PageFind does offer a page_size option, but you cannot set it via the current Starlight API, related discussions:
  • Pagefind Result Filtering/Categories withastro/starlight#2391
  • Add ability to configure Pagefind withastro/starlight#2398
  • Ability to add custom values to `PagefindUI` constructor options (in Search component) withastro/starlight#1358

I think it would be best in this case to wait for official support from Starlight.
In the meantime, I've bumped the website to the latest Starlight version, which does seem to order the results a bit more sanely.

EDIT: I am also going to test out the Algolia DocSearch integration, as that can be configured differently.