# Orama plugin for Docusaurus v2

[![Tests](https://github.com/oramasearch/orama/actions/workflows/turbo.yml/badge.svg)](https://github.com/oramasearch/orama/actions/workflows/turbo.yml)

## Pre-requisites
In order guarantee a correct functionality of the plugin, you need to have the `@docusaurus/core` at least in the version `2.4.3`.

| :warning: This plugin do not support Docusaurus v3. Use [`@orama/plugin-docusaurus-v3`](https://www.npmjs.com/package/@orama/plugin-docusaurus-v3) instead. |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------|

## Usage

Install the plugin:

```bash
npm install --save @orama/plugin-docusaurus
```

```bash
yarn add @orama/plugin-docusaurus
```

Add the plugin to your `docusaurus.config.js`:

```js
plugins: ['@orama/plugin-docusaurus']
```

# License

Licensed under the [Apache 2.0](/LICENSE.md) license.