1
0
Fork 0
docsearch/packages/docsearch-react
renovate[bot] 10c5b2ea14
chore(deps): update lint dependency (#1120)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: Samuel Bodin <1637651+bodinsamuel@users.noreply.github.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
2021-11-02 12:06:22 +01:00
..
src chore(deps): update lint dependency (#1120) 2021-11-02 12:06:22 +01: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.0.0-alpha.41 (#1062) 2021-10-18 10:35:52 +02:00
README.md feat(website): new documentation (#1048) 2021-10-07 12:27:45 +02: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@alpha
# or
npm install @docsearch/react@alpha

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

<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@alpha"></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 →