What is DocSearch?
DocSearch consists of two main components:- DocSearch Crawler - A web crawler that extracts content from your documentation and indexes it in Algolia
- DocSearch UI - A JavaScript library that provides a ready-to-use search interface
How It Works
Apply for DocSearch
Submit your documentation site to the DocSearch program. If you’re running an open-source project or technical documentation, you’ll get free access to Algolia’s search infrastructure.
Crawler Indexes Your Site
The DocSearch crawler automatically visits your documentation site, extracts the content, and indexes it in Algolia. This happens regularly to keep your search index up-to-date.
Add DocSearch to Your Site
Install the DocSearch library and add a few lines of code to your documentation site. The library provides a fully-functional search interface out of the box.
Key Features
Lightning-Fast Search
Powered by Algolia’s search engine, DocSearch delivers results in milliseconds, even for large documentation sites with thousands of pages.Ask AI
Get intelligent, conversational answers from your documentation using AI. Users can ask natural language questions and receive contextual responses with source citations.Multiple Implementations
DocSearch is available in multiple formats:- @docsearch/js - Vanilla JavaScript for any website
- @docsearch/react - React component library
- @docsearch/docusaurus-adapter - Native Docusaurus integration
Customizable
Customize every aspect of DocSearch to match your brand:- Custom colors and themes
- Custom hit templates
- Custom search parameters
- Custom keyboard shortcuts
Accessibility First
DocSearch is built with accessibility in mind:- Full keyboard navigation
- ARIA labels and roles
- Screen reader support
- Focus management
Recent and Favorite Searches
DocSearch remembers your users’ search history and allows them to favorite important searches for quick access.Who Uses DocSearch?
DocSearch powers search for thousands of documentation sites, including:- Bootstrap
- React
- Vue.js
- Webpack
- Babel
- MDN Web Docs (previously)
- And thousands more
DocSearch is completely free for open-source projects and technical documentation. If you’re building commercial documentation, you can still use DocSearch by setting up your own Algolia account.
Next Steps
Ready to add DocSearch to your documentation?Quick Start
Get started with DocSearch in minutes
Apply to DocSearch
Apply for free access to DocSearch
