DocSearch crawls your documentation, pushes the content to an Algolia index and provides a dropdown search experience on your website.

Ask AI demo

Don't have your Algolia credentials yet? Apply to DocSearch!

yarn add @docsearch/js@4
# or
npm install @docsearch/js@4

If you don’t want to use a package manager, you can use a standalone endpoint:

<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@4"></script>

To get started, you need a container for your DocSearch component to go in. If you don’t have one already, you can insert one into your markup:

<div id="docsearch"></div>

Then, insert DocSearch into it by calling the docsearch function and providing the container. It can be a CSS selector or an Element.

Make sure to provide a container (for example, a div), not an input. DocSearch generates a fully accessible search box for you.

import docsearch from '@docsearch/js';
import '@docsearch/css';
docsearch({
 container: '#docsearch',
 appId: 'YOUR_APP_ID',
 indexName: 'YOUR_INDEX_NAME',
 apiKey: 'YOUR_SEARCH_API_KEY',
});

yarn add @docsearch/react@4
# or
npm install @docsearch/react@4

If you don’t want to use a package manager, you can use a standalone endpoint:

<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@4"></script>

DocSearch generates a fully accessible search box for you.

import { DocSearch } from '@docsearch/react';
import '@docsearch/css';
function App() {
 return (
 <DocSearch
 appId="YOUR_APP_ID"
 apiKey="YOUR_SEARCH_API_KEY"
 indices=["YOUR_ALGOLIA_INDEX"]
 />
 );
}
export default App;

Read documentation →

DocSearch is made of the following repositories:

• algolia/docsearch : DocSearch source code.
• algolia/docsearch/packages/website : DocSearch website and documentation.
• algolia/docsearch-configs : DocSearch websites configurations that DocSearch powers.
• algolia/docsearch-scraper : DocSearch crawler that extracts data from your documentation.

MIT