Skip to content

Update docusaurus plugins (v2 & v3) with new React searchbox (0.0.26)#810

Merged
raiindev merged 5 commits intomainfrom
feature/orm-1804-update-docusaurus-searchbox
Oct 8, 2024
Merged

Update docusaurus plugins (v2 & v3) with new React searchbox (0.0.26)#810
raiindev merged 5 commits intomainfrom
feature/orm-1804-update-docusaurus-searchbox

Conversation

@raiindev
Copy link
Copy Markdown
Contributor

@raiindev raiindev commented Oct 4, 2024

Now, use @orama/react-components v0.0.26.
OSS => Will disable chat feat since it is not supported yet.
Cloud => All features enabled.

HOW TO TEST

Orama package

  • Change workspace:* package versions with ^2.1.0 (not all packages have the 2.1.1 version available; better safe than sorry)
  • Launch the following commands pnpm i, pnpm build, npm pack
  • Copy & Paste the created package tgz inside your docusaurus project

Your docusaurus project

  • Add @orama/plugin-docusaurus or @orama/plugin-docusaurus-v3 to your package.json
  • The version of your package should point to your local tgz file (ex. file:./orama-plugin-docusaurus-v3-2.1.1.tgz)
  • Launch the install command
  • Inside your docusaurus.config.js add the following code:
plugins: [
    [
      "@orama/plugin-docusaurus-v3",
      {
        cloud: {
          indexId: '<index_id>',
          oramaCloudAPIKey: '<private_api_key>',
          deploy: 'default' //or false to avoid deploying a new version of it
        }
      }
    ]
  ]
  • AI is disabled by default. To test it, you should add NODE_ENV=production before starting the project (optional)

@vercel
Copy link
Copy Markdown

vercel bot commented Oct 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
orama-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 7, 2024 4:17pm

@raiindev raiindev force-pushed the feature/orm-1804-update-docusaurus-searchbox branch from 13913f3 to 9173431 Compare October 7, 2024 07:11
@raiindev raiindev changed the title [DO NOT MERGE - WAIT REACT COMPONENTS 0.0.26] Update docusaurus plugins (v2 & v3) with new React searchbox Update docusaurus plugins (v2 & v3) with new React searchbox (0.0.26) Oct 7, 2024
@raiindev raiindev force-pushed the feature/orm-1804-update-docusaurus-searchbox branch from 9173431 to a733962 Compare October 7, 2024 16:16
@raiindev raiindev merged commit b4349e1 into main Oct 8, 2024
@raiindev raiindev deleted the feature/orm-1804-update-docusaurus-searchbox branch October 8, 2024 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants