mirror of
https://github.com/imezx/Warp.git
synced 2025-04-24 15:10:03 +00:00
47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
|
# @docsearch/js
|
|||
|
|
|
|||
|
|
JavaScript package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
|
|||
|
|
|
|||
|
|
## Installation
|
|||
|
|
|
|||
|
|
```sh
|
|||
|
|
yarn add @docsearch/js@3
|
|||
|
|
# or
|
|||
|
|
npm install @docsearch/js@3
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Get started
|
|||
|
|
|
|||
|
|
If you don’t want to use a package manager, you can use a standalone endpoint:
|
|||
|
|
|
|||
|
|
```html
|
|||
|
|
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
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
|
|||
|
|
<div id="docsearch"></div>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
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',
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Documentation
|
|||
|
|
|
|||
|
|
[Read documentation →](https://docsearch.algolia.com/docs/DocSearch-v3)
|