JavaScript package for DocSearch, the best search experience for docs.
npm install @docsearch/jsJavaScript package for DocSearch, the best search experience for docs.
``sh`
yarn add @docsearch/js@4or
npm install @docsearch/js@4
If you don’t want to use a package manager, you can use a standalone endpoint:
`html`
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:
`html`
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.
`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',
});
``