devstar插件
This commit is contained in:
43
node_modules/@docsearch/react/README.md
generated
vendored
Normal file
43
node_modules/@docsearch/react/README.md
generated
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
# @docsearch/react
|
||||
|
||||
React package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
yarn add @docsearch/react@3
|
||||
# or
|
||||
npm install @docsearch/react@3
|
||||
```
|
||||
|
||||
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/react@3"></script>
|
||||
```
|
||||
|
||||
## 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 (
|
||||
<DocSearch
|
||||
appId="YOUR_APP_ID"
|
||||
indexName="YOUR_INDEX_NAME"
|
||||
apiKey="YOUR_SEARCH_API_KEY"
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export default App;
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
[Read documentation →](https://docsearch.algolia.com/docs/docsearch-v3)
|
Reference in New Issue
Block a user