Package Exports
- @docsearch/js
- @docsearch/js/dist/esm/index.js
- @docsearch/js/dist/umd/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@docsearch/js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@docsearch/js
JavaScript package for DocSearch, the best search experience for docs.
Installation
yarn add @docsearch/js@4
# or
npm install @docsearch/js@4Get started
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',
});