imba.io icon indicating copy to clipboard operation
imba.io copied to clipboard

Make all text searchable in docs.

Open ericvida opened this issue 4 years ago • 1 comments

A couple of people have expressed the need for all the text in the documentation be searchable, either via the search bar or the browser's text search tool. I would support either solution. I have needed this as well.

image image

ericvida avatar May 30 '21 14:05 ericvida

https://www.algolia.com/for-open-source/ is often quite nice - although it can be frustrating if it doesn't expand into a full search (similar to the current search on Imba.io).

We wouldn't need to build out an entire InstantSearch UI with Imba (although that would be very cool one day! - https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/ for reference), only feed the docs into Algolia with a Github hook and then use the regular JS version in the existing search.

That little "press ctr/cmd + K to search" feels like it's an industry standard now, and seeing that in the nav bar as your first impression could set expectations that Imba is production quality - and not a toy project.

Depending on my schedule in the coming weeks (and if using Algolia, which I already know, is a good path forward) I may be interested in picking this one up! 🖐️

codeluggage avatar Aug 30 '21 12:08 codeluggage