What is DocSearch?
Why?
We created DocSearch because developers spend a lot of time reading documentation, and finding relevant information in large documentation sites can be difficult. Building good search is a challenge.
Algolia has extensive experience building search interfaces. We use that experience to extract content from technical documentation and make it searchable from the first keystroke.
Overview
DocSearch has two independent parts: indexing and the frontend search experience.
- The Algolia Crawler extracts your documentation into an Algolia index. Use the Crawler interface to edit the crawler configuration, monitor crawls, and trigger new crawls.
- The DocSearch v5 packages query that index and render keyword search or Ask AI in your frontend. They are built on Algolia Autocomplete.
Crawler configuration and record schema versions don't select the installed DocSearch frontend package version. You can update the frontend package without changing how the crawler is scheduled.
How to feature DocSearch?
DocSearch is free for eligible documentation sites. Read the eligibility requirements and apply. After approval and indexing, add a DocSearch v5 package or a supported framework integration to your website. 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