gabrielcsapo / docusaurus-plugin-search-local

An offline/local search plugin for Docusaurus v2
https://gabrielcsapo.github.io/docusaurus-plugin-search-local/
MIT License
25 stars 9 forks source link

Generates wrong links with Docusaurus 3.4.0 #82

Open bbhtt opened 4 months ago

bbhtt commented 4 months ago

It is generating wrong links for example searching for "linter errors" and clicking the first result should go to https://docs.flathub.org/docs/for-app-authors/linter#linter-errors but the generated link goes to https://docs.flathub.org/docs/for-app-authors/linter/docs/for-app-authors/linter#linter-errors

slorber commented 4 months ago

Search index before/after, the h attribute looks wrong and should probably not contain the pathname?

CleanShot 2024-07-18 at 15 27 32@2x

This probably happens because the anchor now includes the pathname on Docusaruus side:

CleanShot 2024-07-18 at 15 31 45@2x

While it wasn't the case before:

CleanShot 2024-07-18 at 15 33 18@2x

Although I wonder why our anchors have changed this way (will investigate) I think the bug is in this plugin that should support anchor links containing a pathname, which remains a perfectly valid anchor.

We'll probably need to introduce these kind of links on purpose on the blog to solve bugs like this: https://github.com/facebook/docusaurus/issues/10287

slorber commented 4 months ago

Going to revert the unexpected Docusaurus change for now, but this only buys you time to fix the problem in this plugin because it remains a bug, and we'll have anchor links with a pathname in the future.

https://github.com/facebook/docusaurus/pull/10311

bbhtt commented 4 months ago

Search index before/after, the h attribute looks wrong and should probably not contain the pathname?

I tried to fix it with https://github.com/gabrielcsapo/docusaurus-plugin-search-local/pull/83 but didn't seem to work and I'm not very familiar with docusaurus too.