@orama/plugin-docusaurus-v3

Orama Plugin for Docusaurus v3

Plugin documentation

Local Development

To test the plugin locally, follow these steps:

(Required only if using workspace dependencies):

Replace all the workspace:* packages with the latest version of the package.

Steps:

• Add a link to the plugin in your Docusaurus project:

"dependencies": {
  "@orama/plugin-docusaurus": "file:../path/to/plugin"
}

• Install the plugin:

pnpm install

• Start your Plugin project (plugin folder):

pnpm run watch

• Copy the needed CSS files into dist folder:

pnpm run postbuild

• Start your Docusaurus project:

pnpm start

The Docusaurus project will watch automatically for changes in the plugin, so you can edit the plugin and see the changes in real-time.

Other information

• The Answer Session will not work while working on Staging due to the answer session url being hard-corded to production. To test it please, use prod environment.

For Docusaurus v2, please refer to the v2 branch.