Orama Search Engine Documentation

The @orama/plugin-parsedoc plugin allows you to generate an Orama search index directly from HTML files.

For detailed implementation steps and a complete usage guide, refer to the official plugin documentation.

To release a specific version of your documentation (e.g., version 1.0), use the Docusaurus CLI command. This action copies your current docs folder into a new directory under versioned_docs/version-1.0 and updates versions.json.

After running this command, your site will have two distinct paths:

• The versioned docs (e.g., 1.0) at /docs/.
• The current (upcoming/unreleased) docs at /docs/next/.

npm run docusaurus docs:version 1.0

Install the Orama Plugin PT15, which provides a fast ranking algorithm based on token position, using npm:

npm i @orama/plugin-pt15

Generate static content for production by running yarn build. The output will be located in the build directory and can be hosted on any static content hosting service.

$ yarn build

To start a local development server that opens a browser window and supports live reloading, use the yarn start command.

$ yarn start

Install the Orama Embeddings plugin via npm. Note that you must also install a TensorFlowJS backend for the plugin to function.

Required Backend Installation:

• For Browser environments: @tensorflow/tfjs-backend-webgl is highly recommended.
• For Node.js environments: @tensorflow/tfjs-node is recommended.

Other supported backends include @tensorflow/tfjs, @tensorflow/tfjs-backend-cpu, @tensorflow/tfjs-node-gpu, and @tensorflow/tfjs-backend-wasm.

npm i @orama/plugin-embeddings
# And install a backend, e.g., for Node.js:
npm i @tensorflow/tfjs-node

To use Orama search in a Docusaurus v2 project, install the @orama/plugin-docusaurus package using npm or yarn.

npm install --save @orama/plugin-docusaurus

# or

yarn add @orama/plugin-docusaurus

You can build your site for a single specific locale or build all locales simultaneously.

Build for a specific locale:

npm run build -- --locale fr

Build all locales:

npm run build

To edit content for specific versions, modify the files within their respective directories:

• Versioned content: Edit files in versioned_docs/version-<version_name>/ to update that specific version's URL (e.g., http://localhost:3000/docs/hello).
• Current/Unreleased content: Edit files in the docs/ folder to update the next version (e.g., http://localhost:3000/docs/next/hello).

Orama supports stemming to optimize queries and save indexing space. To enable stemming, you must configure the tokenizer within your schema to include stemming: true, the specific stemmer function, and the language constant imported from the corresponding language package (e.g., @orama/stemmers/italian).

Note: Chinese (Mandarin) and Japanese are not supported via stemming; they require dedicated tokenizers (@orama/tokenizers) and stop-word removal (@orama/stopwords).

import { create } from '@orama/orama'
import { stemmer, language } from '@orama/stemmers/italian'

const db = create({
  schema: {
  components: {
    tokenizer: {
      stemming: true,
      stemmer,
      language
    }
  }
})

You can add metadata to the top of your Markdown files using Front Matter. This metadata is enclosed in triple dashes (---) and can define properties like id, title, description, and slug.

---
id: my-doc-id
title: My document title
description: My document description
slug: /my-custom-url
---

## Markdown heading

Markdown text with [links](./hello.md)