Skip to content

Commit

Permalink
add to cloud
Browse files Browse the repository at this point in the history
  • Loading branch information
SaraVieira committed Apr 9, 2024
1 parent 03aa731 commit cf6d19d
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,61 @@ outline: deep

# Connect Orama Cloud to Docusaurus

Docusaurus integration is coming soon. Please [contact us](mailto:info@oramasearch.com) or [join our Slack channel](https://orama.to/slack) if you want to be notified when it's ready.
## 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`](https://www.npmjs.com/package/@orama/plugin-docusaurus) instead.
:::

## Installation

You can install the plugin using any major Node.js package manager:

```bash copy
npm install @orama/plugin-docusaurus-v3
```

```bash copy
pnpm install @orama/plugin-docusaurus-v3
```

```bash copy
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:

![select integrations](/oss/docussarus-1.png)

And then docusaurus:

![select Docusaurus](/oss/docussarus-2.png)

On the next page you will see all the variables you need to get you up and running:

![the variables](/oss/docussarus-3.png)

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.
6 changes: 5 additions & 1 deletion packages/docs/open-source/plugins/plugin-docusaurus.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ plugins: [
"@orama/plugin-docusaurus-v3",
{
cloud: {
indexId: process.env.ORAMA_CLOUD_INDEX_ID, // Env variable suggested
indexId: "<your_orama_index_id>",
oramaCloudAPIKey: process.env.ORAMA_CLOUD_API_KEY, // Env variable suggested
deploy: true, // Enables deploy while building/starting
},
Expand All @@ -76,4 +76,8 @@ And then docusaurus:

![select Docusaurus](/oss/docussarus-2.png)

On the next page you will see all the variables you need to get you up and running:

![the variables](/oss/docussarus-3.png)

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.
Binary file added packages/docs/public/oss/docussarus-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cf6d19d

Please sign in to comment.