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

add local search with plugin @easyops-cn/docusaurus-search-local #1509

Merged
merged 2 commits into from
Apr 26, 2023

Conversation

windmemory
Copy link
Member

@windmemory windmemory commented Dec 27, 2022

Fix #666

Currently we are using algolia to implement the search feature across the whole website, but for some unknown reason, the search is broken, there is no any results showed in the result page.

This PR refer to docusaurus community recommended plugin @easyops-cn/docusaurus-search-local to implmenet the search feature, the result looks pretty good, and it is a local search engine, no 3rd party service needed for this feature. Seems like a good option for open source community.

Results screenshots:

Regular mode:
image

Dark mode:
image

Reference:
https://docusaurus.io/docs/search#using-local-search
https://github.com/easyops-cn/docusaurus-search-local

@windmemory windmemory requested a review from huan April 26, 2023 05:41
Copy link
Member

@huan huan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Thanks for the fix! It looks good, and let's see how it works online.

One more thing: could we use the official docusaurus-search-local after it supports zh language? Because I think the zh language support will be merged to the upstream in the future.

Good job btw!

@huan huan merged commit 2630d89 into wechaty:main Apr 26, 2023
@huan huan mentioned this pull request Apr 26, 2023
@windmemory windmemory deleted the feat/add-local-search branch April 26, 2023 10:53
@windmemory
Copy link
Member Author

LGTM

Thanks for the fix! It looks good, and let's see how it works online.

One more thing: could we use the official docusaurus-search-local after it supports zh language? Because I think the zh language support will be merged to the upstream in the future.

Good job btw!

I think it should work when we have zh support, let's see how it goes, I am glad to make it work for zh if wechaty docs supports zh and the search broken.

@windmemory
Copy link
Member Author

image
Seems like search in zh works well with this plugin.

@huan
Copy link
Member

huan commented Apr 26, 2023

Fantastic! Thank you very much for the confirming!

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.

search failures on website
2 participants