@aliyun-sls/docsearch-react
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

@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 don’t 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 →

Readme

Keywords

none

Package Sidebar

Install

npm i @aliyun-sls/docsearch-react

Weekly Downloads

5

Version

1.0.2

License

MIT

Unpacked Size

139 kB

Total Files

101

Last publish

Collaborators

  • nosmilen
  • ruiqi.hy
  • yuecjnadt
  • perezyuan