Product Updates
November 17, 2023

Orama Support for Docusaurus v3

On October 31st, the Docusaurus team announced a new, major version of the popular documentation tool, provided by Meta.

This version introduced significant changes, including:

  • Updating React from v17 to v18
  • Updating MDX from v1 to v3
  • Updating TypeScript from v4 to v5

among many others. You can find the complete list here.

If you haven't done so yet, you can upgrade Docusaurus to v3 by following the official guide.

Docusaurus v3 and Orama

Considering the numerous breaking changes introduced by this upgrade, we decided to release a new, separate plugin for integrating Orama with Docusaurus v3.

Docusaurus v2 is widely used and will continue to be so. As a result, we will continue to maintain the @orama/plugin-docusaurus plugin, ensuring compatibility with Docusaurus v2. Simultaneously, we will maintain @orama/plugin-docusaurus-v3, which will always be compatible with Docusaurus v3.

From a technical perspective, installing the new plugin on Docusaurus v3 follows the same process as Docusaurus v2.

You simply need to install @orama/plugin-docusaurus-v3:

1npm i @orama/plugin-docusaurus-v3

And add the plugin to your docusaurus.config.js file:

2  // ...
3  plugins: ["@orama/plugin-docusaurus-v3"],
4  // ...

That's it! In fact, if you're upgrading your Docusaurus version to v3, you can follow this exact procedure to upgrade the Orama plugin as well.

The Future of Orama and Docusaurus

Docusaurus is becoming a de-facto standard for documentation due to its ease of use, maintainability, and deployment.

In Orama v2.0.0-beta.6, we released a significant update that can reduce the index size by 35%. We will continue to optimize it to provide the best developer and user experience for searching through documentation.

In the coming weeks, we'll be making some significant announcements, including updates about our Docusaurus integrations. Be sure to follow us on Twitter and Slack to stay informed!

In the meantime, remember to keep your dependencies updated!

Posted by

Michele Riva

CTO @OramaSearch