Connect Orama Cloud to Docusaurus
Pre-requisites
In order guarantee a correct functionality of the plugin, you need to have the @docusaurus/core
at least in the version 3.2.0
.
WARNING
This plugin do not support Docusaurus v2. Use @orama/plugin-docusaurus
instead.
Installation
You can install the plugin using any major Node.js package manager:
bash
npm install @orama/plugin-docusaurus-v3
bash
pnpm install @orama/plugin-docusaurus-v3
bash
yarn add @orama/plugin-docusaurus-v3
Usage
To use the plugin you will need to add it to your docusaurus list of plugins:
js
// ...
plugins: [
[
"@orama/plugin-docusaurus-v3",
{
cloud: {
indexId: "<your_orama_index_id>",
oramaCloudAPIKey: process.env.ORAMA_CLOUD_API_KEY, // Env variable suggested
deploy: true, // Enables deploy while building/starting
},
},
],
];
// ...
To get this variables first create a new integration for HTTP Integrations in here:
And then docusaurus:
On the next page you will see all the variables you need to get you up and running:
And you are set, if you set deploy to true your index will update whenever you build the website and there are changes to your pages.