# vuepress-plugin-full-text-search2

> VuePress v2 plugin that adds full-text search box.

Latest version **0.5.1** (published 2024-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install vuepress-plugin-full-text-search2
pnpm add vuepress-plugin-full-text-search2
yarn add vuepress-plugin-full-text-search2
bun add vuepress-plugin-full-text-search2
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2024-02-28 |
| First published | 2022-09-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 39 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 38 |
| Author | Yosuke Ota |
| Maintainers | ota-meshi |
| Keywords | vuepress, vuepress-plugin, full-text-search, vuepress-next |

## Links

- npm: https://www.npmjs.com/package/vuepress-plugin-full-text-search2
- Repository: https://github.com/ota-meshi/vuepress-plugin-full-text-search2
- Homepage: https://github.com/ota-meshi/vuepress-plugin-full-text-search2#readme
- Issues: https://github.com/ota-meshi/vuepress-plugin-full-text-search2/issues
- Funding: https://github.com/sponsors/ota-meshi
- npm.io page: https://npm.io/package/vuepress-plugin-full-text-search2

## Dependencies (6)

- [vue](https://npm.io/package/vue.md) ^3.2.0
- [chokidar](https://npm.io/package/chokidar.md) ^3.5.2
- [htmlparser2](https://npm.io/package/htmlparser2.md) ^9.0.0
- [@vuepress/core](https://npm.io/package/@vuepress/core.md) ^2.0.0-0
- [@vuepress/utils](https://npm.io/package/@vuepress/utils.md) ^2.0.0-0
- [@vuepress/client](https://npm.io/package/@vuepress/client.md) ^2.0.0-beta.29

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.5.1 (latest) — 2024-02-28
- 0.4.0 — 2022-09-01
- 0.3.0 — 2022-09-01

## README

# vuepress-plugin-full-text-search2

[VuePress v2] plugin that adds full-text search box.

![screenshot](./screenshot.png)

[vuepress v2]: https://v2.vuepress.vuejs.org/

:warning: WARNING: this project is considered to be in BETA until [VuePress v2] is available for general use and the API is stable!

## Usage

```shell
npm i -D vuepress-plugin-full-text-search2
```

e.g. `.vuepress/config.js`

```js
import fullTextSearchPlugin from "vuepress-plugin-full-text-search2";
module.exports = {
  plugins: [fullTextSearchPlugin],
};
```

## Options

### locales

- Type: `Record<string, { placeholder: string }>`

- Details:

  The text of the search box in different locales.

  If this option is not specified, it will fallback to default text.

- Example:

```ts
import fullTextSearchPlugin from "vuepress-plugin-full-text-search2";
export default {
  plugins: [
    fullTextSearchPlugin({
      locales: {
        '/': {
          placeholder: 'Search',
        },
        '/zh/': {
          placeholder: '搜索',
        },
      },
    }),
  ],
}
```

- Also see:
  - [VuePress v2 - Guide > I18n]([../../guide/i18n.md](https://v2.vuepress.vuejs.org/guide/i18n.html))

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