1
0
Fork 0
docsearch/packages/docsearch-react
Shane Afsar 982a229231
chore: release v3.5.2 (#2020)
* chore: release v3.5.2

* Adds content to CHANGELOG

---------

Co-authored-by: Paul Jankowski <8BitTitan@gmail.com>
2023-08-17 10:04:58 -04:00
..
src chore: release v3.5.2 (#2020) 2023-08-17 10:04:58 -04:00
style chore: move docsearch-react to packages 2020-09-01 11:36:46 +02:00
babel.config.js chore: ignore no-commonjs lint rule for config files 2020-11-12 17:32:52 +01:00
button.js chore: move docsearch-react to packages 2020-09-01 11:36:46 +02:00
modal.js chore: move docsearch-react to packages 2020-09-01 11:36:46 +02:00
package.json chore: release v3.5.2 (#2020) 2023-08-17 10:04:58 -04:00
README.md chore: release v3.0.0 (#1311) 2022-02-22 12:52:15 +01:00
rollup.config.js fix(build): remove occurences of process in UMD build (#1047) 2021-09-20 11:37:51 +02:00
tsconfig.declaration.json chore: update TypeScript 2020-11-25 11:37:58 +01:00

@docsearch/react

React package for DocSearch, the best search experience for docs.

Installation

yarn add @docsearch/react@3
# or
npm install @docsearch/react@3

If you dont want to use a package manager, you can use a standalone endpoint:

<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@3"></script>

Get started

DocSearch generates a fully accessible search box for you.

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 →