Skip to main content

Here comes the documentation search!

· 2 min read
Thibaut Raballand
Creator of Spider

Jérémy M mentioned to me recently that this documentation was missing a search feature.
Here it comes!

Adding search reminded me something and I checked docusaurus documentation: Guides/Search

Algolia is provided search for many Websites, and they are offering a specific plan for technical documentation websites using Docusaurus or other technologies: DocSearch.

There is even a free plan up to 10k items in the index.
Perfect, let's try 😀

Literally,

  • I applied for the plan
  • spider-analyzer.io was accepted the following day - fast!
  • The time to create the account and then adjust the configuration, less than 15 minutes later, the search was available (and deployed)!

Amazing! 🎉

This is what I call frictionless ! 😉
Writing this blog post takes longer than adding the search!

Search component​

Algolia search UI is completely integrated and very nice out of the box!

SearchComponent.png

Press Ctrl+K or click on it, and you can search through the whole website, and at blazing fast speed!

SearchPanel.png

Validate your choice, using keyboard or mouse and you jump straight to the page.

Search page​

Docusaurus also provides a search page out of the box: https://spider-analyzer.io/search/

It has a clear api, like https://spider-analyzer.io/search/?q=Controll and is completely responsive with infinite scroll!

SearchPage.png

That rocks! 😍😍😍

Index management​

I wasn't expecting it, but Algolia comes with complete index management dashboard with AI, synonyms, etc.

IndexMgt.png

So professional! Thanks guys, I'll explore all this 😲

At the time of writing, my index contains 5 275 items.
With all Spider history of blog items aging from 2017! Way to go 😊

Cheers,
Thibaut