Missing functionality in Search

[amirhouieh]

Copy/pasting from https://github.com/status-im/infra-misc/issues/143#issuecomment-1768331627 by @zah

If we use the framework for the Nimbus guide, I feel the quality of the search box will be lower in comparison to our current solution. In particular, our current system (https://www.mkdocs.org/) offers the following features:

1. When you search, you can navigate and select search results by using the arrow keys on your keyboard (pressing ENTER takes you to the selected result).

2. The offered instant results feature snippets that show the content around the matched search keywords, which makes it easier for the user to select the right page to navigate to.

Please note that this doesn't seem to be a limitation of Docusaurus itself, but rather a problem in the current implementation. As an example, the documentation site of Prysm is based on Docusaurus and has a decent search box:

https://docs.prylabs.network/docs/getting-started

Originally posted by @zah in https://github.com/status-im/infra-misc/issues/143#issuecomment-1768331627_

[jeangovil]

@zah, thank you for raising the issue. We will implement the changes you've suggested. It's worth noting that Docusaurus doesn't have built-in local search functionality. We've extended an open-source plugin and implemented our own UI.

If you come across any other issues or have more ideas for improvement, feel free to open a new issue in this repository.

[zah]

For reference, you can see how the Nimbus Guide search works here:
https://nimbus.guide/