# gitbook-plugin-search

> Search input for your GitBook

Latest version **2.2.1** (published 2016-04-20) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install gitbook-plugin-search
pnpm add gitbook-plugin-search
yarn add gitbook-plugin-search
bun add gitbook-plugin-search
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.1 |
| Published | 2016-04-20 |
| First published | 2015-10-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Maintainers | jpreynat, samypesse |

## Links

- npm: https://www.npmjs.com/package/gitbook-plugin-search
- Repository: https://github.com/GitbookIO/plugin-search
- Issues: https://github.com/GitbookIO/plugin-search/issues
- npm.io page: https://npm.io/package/gitbook-plugin-search

## Recent versions

- 2.2.1 (latest) — 2016-04-20
- 4.0.0-alpha.6 (pre) — 2017-03-16
- 4.0.0-alpha.5 — 2017-03-09
- 4.0.0-alpha.4 — 2017-01-27
- 4.0.0-alpha.3 — 2017-01-13
- 4.0.0-alpha.2 — 2017-01-13
- 4.0.0-alpha.1 — 2017-01-13
- 2.2.0 — 2016-04-19
- 2.1.0 — 2016-04-19
- 2.0.1 — 2016-04-18
- 2.0.0 — 2016-04-14
- 1.2.0 — 2016-03-07
- 1.1.0 — 2015-11-16
- 1.0.2 — 2015-10-13
- 1.0.1 — 2015-10-13
- … 1 more at https://npm.io/package/gitbook-plugin-search/versions

## README

# search

This plugin is a default plugin for GitBook, it adds an interactive search bar to your book.

This plugin is backend agnostic.

### Disable this plugin

This is a default plugin and it can be disabled using a `book.json` configuration:

```
{
    plugins: ["-search"]
}
```

### Backends

| Backend | Plugin Name | Description |
| ------- | ----------- | ----------- |
| [Lunr](https://github.com/GitbookIO/plugin-lunr) | `lunr` | Index the content into a local/offlien index |
| [Algolia](https://github.com/GitbookIO/plugin-algolia) | `algolia` | Index the content in Algolia |

---
_Source: https://npm.io/package/gitbook-plugin-search · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._