[![DocSearch](.github/logo.svg)](https://docsearch.algolia.com) The easiest way to add search to your documentation – for free. [![Netlify Status](https://api.netlify.com/api/v1/badges/30eacc09-d4b2-4a53-879b-04d40aaea454/deploy-status)](https://app.netlify.com/sites/docsearch/deploys) [![npm version](https://img.shields.io/npm/v/@docsearch/js.svg?style=flat-square)](https://www.npmjs.com/package/@docsearch/js/v/alpha) [![Used by](https://img.shields.io/endpoint?style=flat-square&url=https://api.usedby.dev/npm/@docsearch/js/shield.json)](https://github.com/algolia/docsearch/network/dependents) [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square)](./LICENSE)

Documentation • JavaScript Playground • React Playground

--- DocSearch crawls your documentation, pushes the content to an Algolia index and provides a dropdown search experience on your website. ## Preview ![Ask AI demo](packages/website/static/img/resources/askai_demo.gif) ## Usage > Don't have your Algolia credentials yet? [Apply to DocSearch](https://docsearch.algolia.com/apply)! ### JavaScript #### Installation ```sh 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: ```html ``` #### Get started To get started, you need a [`container`](https://docsearch.algolia.com/docs/api#container) for your DocSearch component to go in. If you don’t have one already, you can insert one into your markup: ```html
``` Then, insert DocSearch into it by calling the [`docsearch`](https://docsearch.algolia.com/docs/api) function and providing the container. It can be a [CSS selector](https://developer.mozilla.org/en-us/docs/web/css/css_selectors) or an [Element](https://developer.mozilla.org/en-us/docs/web/api/htmlelement). Make sure to provide a [`container`](https://docsearch.algolia.com/docs/api#container) (for example, a `div`), not an `input`. DocSearch generates a fully accessible search box for you. ```js app.js import docsearch from '@docsearch/js'; import '@docsearch/css'; docsearch({ container: '#docsearch', appId: 'YOUR_APP_ID', indexName: 'YOUR_INDEX_NAME', apiKey: 'YOUR_SEARCH_API_KEY', }); ``` ### React #### Installation ```bash 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: ```html ``` #### Get started DocSearch generates a fully accessible search box for you. ```jsx App.js import { DocSearch } from '@docsearch/react'; import '@docsearch/css'; function App() { return ( ); } export default App; ``` ## Styling [Read documentation →](https://docsearch.algolia.com/docs/styling) ## Related projects DocSearch is made of the following repositories: - **[algolia/docsearch](https://github.com/algolia/docsearch)**: DocSearch source code. - **[algolia/docsearch/packages/website](https://github.com/algolia/docsearch/tree/main/packages/website)**: DocSearch website and documentation. - **[algolia/docsearch-configs](https://github.com/algolia/docsearch-configs)**: DocSearch websites configurations that DocSearch powers. - **[algolia/docsearch-scraper](https://github.com/algolia/docsearch-scraper)**: DocSearch crawler that extracts data from your documentation. ## Used by DocSearch is used by [Bootstrap](https://github.com/twbs/bootstrap), [Cheerio](https://github.com/cheeriojs/cheerio), [Element Plus](https://github.com/element-plus/element-plus), [Authelia](https://github.com/authelia/authelia), [MDX](https://github.com/mdx-js/mdx), [VitePress](https://github.com/vuejs/vitepress) and [many more](https://github.com/algolia/docsearch/network/dependents). [![Used by](https://api.usedby.dev/npm/@docsearch/js?max=50&sort=stars)](https://github.com/algolia/docsearch/network/dependents) Generated with [usedby.dev](https://usedby.dev/) ## License [MIT](LICENSE)