Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔧 [CHANGE] - upgrade to Docusaurus 3 - search plugin #409

Open
MatissJanis opened this issue Jul 13, 2024 · 5 comments
Open

🔧 [CHANGE] - upgrade to Docusaurus 3 - search plugin #409

MatissJanis opened this issue Jul 13, 2024 · 5 comments
Assignees
Labels

Comments

@MatissJanis
Copy link
Member

Description

The current search plugin for docusaurus has two issues:

  1. it is not compatible with docusaurus v3 (which prohibits us from upgrading)
  2. it indexes all pages (ideally we should not index the release notes since they just spam the search results)

Expected behavior

Find a solution to solve the above two issues. This might require switching to a different search plugin.

@MatissJanis MatissJanis added the help wanted Extra attention is needed label Jul 13, 2024
@RubenOlsen
Copy link
Member

RubenOlsen commented Jul 29, 2024

@MatissJanis I'll take a look at this.

@psybers
Copy link
Contributor

psybers commented Oct 6, 2024

@psybers
Copy link
Contributor

psybers commented Oct 6, 2024

Sorry, linked to the old page. Here is the current: https://docusaurus.io/docs/search

@psybers
Copy link
Contributor

psybers commented Oct 6, 2024

But also maybe the existing search plugin works on v3? cmfcmf/docusaurus-search-local#205

And there was a PR to support ignoring paths: https://github.com/cmfcmf/docusaurus-search-local/pull/87/files

We could fork that plugin and add that support.

@RubenOlsen RubenOlsen self-assigned this Oct 10, 2024
@RubenOlsen
Copy link
Member

@psybers, thanks for the pointer. I am planning to start working on this issue next week.

@RubenOlsen RubenOlsen added 🚧 WIP and removed help wanted Extra attention is needed labels Oct 22, 2024
@RubenOlsen RubenOlsen changed the title 🔧 [CHANGE] - search plugin 🔧 [CHANGE] - upgrade to Docusaurus 3 - search plugin Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants