[@orama/plugin-docusaurus-v3] Missing documentation

[Lucioschenkel]

Describe the bug

I upgraded @orama/plugin-docusaurus-v3 on my project from v3.1.1 to v.3.1.18, and my search results got messed up. I had it configured to show the page title and the section's contents with highlighting enabled, but once I upgraded the plugin my search results would only display the section's contents and no highlighting.

To Reproduce

I created a minimal example here: https://github.com/Lucioschenkel/docusaurus-orama-example.

HEAD is with @orama/plugin-docusaurus-v3 at v3.1.18, HEAD~1 is a working example using the same config, and @orama/plugin-docusaurus-v3 at 3.1.1.

Expected behavior

Since this was a patch version update, I didn't expect breaking changes the the API. I also couldn't find any documentation on how the components should behave. The links to the SearchBox and SearchButton components docs are broken: https://docs.orama.com/docs/orama-js/plugins/plugin-docusaurus

Environment Info

OS: Mac 26.2
Node: v24.11.1
Docusaurus: 3.9.1
`@orama/plugin-docusaurus-v3`: `3.1.18`

Affected areas

Search

Additional context

Non-working example:

Working example (using v3.1.1):

[micheleriva]

hi @Lucioschenkel

Since this was a patch version update, I didn't expect breaking changes the the API

I completely agree, that must have been accidental. We're looking into it

[Lucioschenkel]

hi @Lucioschenkel

Since this was a patch version update, I didn't expect breaking changes the the API

I completely agree, that must have been accidental. We're looking into it

@micheleriva Thank you! I really appreciate it. I'll watch this issue for updates.

[thefat32]

Same problem! I can confirm this is introduced from 3.1.11 to 3.1.12 update

EDIT: I've beeen playing around with Docusaurus + Orama for a while, even configured it to deploy and use an index from Orama Cloud. I had to clone the code and figure the configurations because there isn't any documentation on using Orama Cloud.

This bug seems to happen only in OSS mode and it's really weird sometimes it works as intended and it seems to be random :/

[Lucioschenkel]

Hi @micheleriva, do you have any updates on this issue? I also ran into a similar problem while upgrading docusaurus to enable future.faster — looks like the new html minimizer breaks the excerpts and highlights in search results.