typesense / docusaurus-theme-search-typesense

A fork of the awesome @docusaurus/theme-search-algolia library customized to work with Typesense
https://typesense.org/docs/guide/docsearch.html
MIT License
63 stars 15 forks source link

Support for Docusaurus 3.3.2 #45

Closed timolagus closed 4 months ago

timolagus commented 4 months ago

Description

Add support for Docusaurus 3.3.2.

Steps to reproduce

Update to the following dependency versions in package.json:

@docusaurus/core: 3.3.2
@docusaurus/module-type-aliases: 3.3.2
@docusaurus/preset-classic: 3.3.2
@docusaurus/theme-live-codeblock: ^3.3.2
@docusaurus/theme-mermaid: ^3.3.2
@docusaurus/types: 3.3.2

Expected Behavior

npm install completes without issue.

Actual Behavior

npm install fails with:

npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR!
npm ERR! While resolving: docusaurus-theme-search-typesense@0.18.0
npm ERR! Found: @docusaurus/core@3.3.2
npm ERR! node_modules/@docusaurus/core
npm ERR!   @docusaurus/core@"3.3.2" from the root project
npm ERR!   @docusaurus/core@"3.3.2" from @docusaurus/plugin-debug@3.3.2
npm ERR!   node_modules/@docusaurus/plugin-debug
npm ERR!     @docusaurus/plugin-debug@"3.3.2" from @docusaurus/preset-classic@3.3.2
npm ERR!     node_modules/@docusaurus/preset-classic
npm ERR!       @docusaurus/preset-classic@"3.3.2" from the root project
npm ERR!   24 more (@docusaurus/plugin-google-analytics, ...)
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer @docusaurus/core@"3.2.1" from docusaurus-theme-search-typesense@0.18.0
npm ERR! node_modules/docusaurus-theme-search-typesense
npm ERR!   docusaurus-theme-search-typesense@"^0.18.0" from the root project
npm ERR!
npm ERR! Conflicting peer dependency: @docusaurus/core@3.2.1
npm ERR! node_modules/@docusaurus/core
npm ERR!   peer @docusaurus/core@"3.2.1" from docusaurus-theme-search-typesense@0.18.0
npm ERR!   node_modules/docusaurus-theme-search-typesense
npm ERR!     docusaurus-theme-search-typesense@"^0.18.0" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.

Metadata

Typesense Version: 0.25.1

OS: Ubuntu 22.04.3 LTS

timolagus commented 4 months ago

@jasonbosco: Updating the package.json manifest file with the latest Docusaurus dependency versions is certainly something I could do. However, I obviously do not have permission to push a new branch to the docusaurus-theme-search-typesense remote repository. Is it possible for me to get said permission, so that I can then create a pull request?

Sidenote: I've never ever before contributed to an open-source project on GitHub (or anywhere else). I've barely used GitHub. (I'm much more familiar with GitLab.) So, apologies if it looks like I'm flailing about -- I probably am. 😄

jasonbosco commented 4 months ago

I missed the notification for your original issue. Will push out an update shortly.

re: your side note, you'd typically want to first fork the repo into your GitHub profile, then make changes, commit to your repo and then send a pull request from your repo to the source repo. So you don't need permissions on the source repo to send PRs.

jasonbosco commented 4 months ago

Just published 0.19.0-0. Could you give it a shot and let me know how it goes?

timolagus commented 4 months ago

Tried and tested. Docusaurus builds OK and search works normally. ✅

Thank you, @jasonbosco!

PS. I shall give the fork approach try in the near future, thanks.

jasonbosco commented 4 months ago

Thank you for confirming. Just published 0.19.0.