Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@orama/plugin-docusaurus

oramasearch506Apache-2.03.1.7TypeScript support: included

Docusaurus plugin for local search powered by Orama

orama, docusaurus

readme

Orama plugin for Docusaurus v2

Tests

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 instead.

Usage

Install the plugin:

npm install --save @orama/plugin-docusaurus
yarn add @orama/plugin-docusaurus

Add the plugin to your docusaurus.config.js:

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

License

Licensed under the Apache 2.0 license.