Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/docsearch
:blue_book: The easiest way to add search to your documentation.
https://github.com/algolia/docsearch
algolia docsearch documentation javascript react search typescript
Last synced: 5 days ago
JSON representation
:blue_book: The easiest way to add search to your documentation.
- Host: GitHub
- URL: https://github.com/algolia/docsearch
- Owner: algolia
- License: mit
- Created: 2015-11-20T22:55:10.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-12-07T18:52:17.000Z (6 days ago)
- Last Synced: 2024-12-08T02:04:18.585Z (6 days ago)
- Topics: algolia, docsearch, documentation, javascript, react, search, typescript
- Language: TypeScript
- Homepage: https://docsearch.algolia.com
- Size: 54.1 MB
- Stars: 4,032
- Watchers: 100
- Forks: 390
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://docsearch.algolia.com)
The easiest way to add search to your documentation – for free.
[](https://app.netlify.com/sites/docsearch/deploys) [](https://www.npmjs.com/package/@docsearch/js/v/alpha) [](./LICENSE)
---
DocSearch crawls your documentation, pushes the content to an Algolia index and provides a dropdown search experience on your website.
## Preview
| Light | Dark |
| --- | --- |
|  |  |
## Usage
> Don't have your Algolia credentials yet? [Apply to DocSearch](https://docsearch.algolia.com/apply)!
### JavaScript
#### Installation
```sh
yarn add @docsearch/js@3
# or
npm install @docsearch/js@3
```
If you don’t want to use a package manager, you can use a standalone endpoint:
```html
```
#### Get started
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
```
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',
});
```
### React
#### 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
```
#### 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 (
);
}
export default App;
```
## Styling
[Read documentation →](https://docsearch.algolia.com/docs/styling)
## Related projects
DocSearch is made of the following repositories:
- **[algolia/docsearch](https://github.com/algolia/docsearch)**: DocSearch source code.
- **[algolia/docsearch/packages/website](https://github.com/algolia/docsearch/tree/main/packages/website)**: DocSearch website and documentation.
- **[algolia/docsearch-configs](https://github.com/algolia/docsearch-configs)**: DocSearch websites configurations that DocSearch powers.
- **[algolia/docsearch-scraper](https://github.com/algolia/docsearch-scraper)**: DocSearch crawler that extracts data from your documentation.
## License
[MIT](LICENSE)