We have created DocSearch because we are scratching our own itch. As developers, we spent a lot of time reading documentation, and it can be hard to find relevant information in large documentations. We're not blaming anyone here; building a good search is a challenge.
It happens that we are a search company and we actually have a lot of experience building search interfaces. We wanted to use those skills to help others. That's why we created a way to automatically extract content from tech documentation and make it available to everyone from the first keystroke.
We split DocSearch into a crawler and a frontend library.
- Crawls are handled by the Algolia Crawler and scheduled to run once a week by default, you can then trigger new crawls yourself and monitor them directly from the Crawler interface, which also offers a live editor where you can maintain your config.
- The frontend library is built on top of Algolia Autocomplete and provides an immersive search experience through its modal.
How to feature DocSearch?
DocSearch is entirely free and automated. The one thing we'll need from you is to read our checklist and apply! After that, we'll share with you the snippet needed to add DocSearch to your website. We ask that you keep the "Search by Algolia" link displayed.
DocSearch is one of our ways to give back to the open source community for everything it did for us already.
You can now apply to the program