Pagefind plugin for local search

facebook / docusaurus

Easy to maintain open source documentation websites.

https://docusaurus.io

MIT License

56.28k stars 8.45k forks source link

Pagefind plugin for local search #10290

Closed tisonkun closed 3 months ago

tisonkun commented 3 months ago

Have you read the Contributing Guidelines on issues?

[X] I have read the Contributing Guidelines on issues.

Motivation

Related docs:

https://pagefind.app/docs/ui-usage/

Other frameworks' integration API:

https://starlight.astro.build/guides/site-search/#_top

Issue in the other side:

https://github.com/CloudCannon/pagefind/issues/447

Self-service

[ ] I'd be willing to do some initial work on this proposal myself.

slorber commented 3 months ago

Sorry but we don't plan to provide a first-party integration with every other local search lib that exists.

A Docusaurus plugin for pathfind can be created in userland by the community, we don't plan to create it ourselves.

At best, we'll eventually provide a single offline search plugin based on the library of our choice, but it's not a top priority for us considering third-party plugins already exist.