Searchable docs

[osdiab]

Right now the docs have no site wide search, which makes it hard to find things. Would be great if this docs site supported this like other modern libraries.

[thejackshelton]

Completely agree. Would you like to take a stab at it @osdiab ?

[JerryWu1234]

let me take this pr, but Could you provide any requirement for searching library that we will be using this project?

[thejackshelton]

let me take this pr, but Could you provide any requirement for searching library that we will be using this project?

Sure! I think in particular something similar to Kobalte here:
https://kobalte.dev/docs/core/overview/introduction

qwik-ui-search.mp4

This uses Algolia, which the Qwik docs also use if you're looking for a source of inspiration.

Ideal search functionality

• Searchable across the docs
• Can navigate to specific sections on a page
• It can collect feedback / search terms from users to improve the docs experience

As for the searching component behavior, you may be able to use the Qwik UI combobox for searching. It is in a big need of a refactor, but for the time being it could work (unless there is a more seamless solution).

If you run into any trouble @JerryWu1234 happy to answer questions and chat in voice! At some point I will be refactoring the Combobox in the near future.

If we think algolia is the way to go, I'd be happy to make an account for it and get us set up, and hand it off.

[JerryWu1234]

@thejackshelton
Do I use my algolia accounts or you offer one ?

[PatrickJS]

@shairez can you get algolia account

[shairez]

Just opened an algolia account for Qwik UI 🎉

If you have experience with it please DM me on discord, it'll probably save me some of the setup time