[Documentation] [Feature Request] Enable search in documentation

[kavimaluskam]

I am new to this project and found it super useful! But as i am not familiar to the resource in this project, and it would be great if the documentation support searching!

As the documentation is by docusaurus, any concern on integrating search by Algolia?

[mingrammer]

It would be good to support. I need to review this feature.

[guyzyl]

@mingrammer Here's the relevant Docusaurus documentation regarding integrating Algolia search.
Are you open for a PR for the feature?

[Collinbrown95]

@mingrammer Would a PR be accepted to upgrade Docusaurus to version 2.0.0 or switch to another static site generator that supports local search out-of-the-box (e.g. mkdocs)?

It looks like Docusaurus version >= 2.x.x supports multiple search options, including local search plugins, whereas 1.x.x appears to only support Algolia.

Given that the docs site is relatively small, my instinct is that a local search plugin would be more than sufficient.

Update: I made a prototype mkdocs site for this project with search enabled. I added a line of configuration to split search terms on - and . characters since many of the useful items in the docs are separated by a .. I did a quick test of the mkdocs search feature and I found it to be satisfactory and convenient. If you are interested, I would be happy to open a pull request to this repository and implement the above change.