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

Search feature on documentation #168

Open
Hans5958 opened this issue Mar 5, 2022 · 5 comments
Open

Search feature on documentation #168

Hans5958 opened this issue Mar 5, 2022 · 5 comments
Labels
help wanted Extra attention is needed scope: docs Related to the documentation (Scratch Addons Docs) scope: engine Related to the scripts and Hugo stuff of the website type: enhancement New feature or request

Comments

@Hans5958
Copy link
Member

Hans5958 commented Mar 5, 2022

This is a dream of mine, but I haven't got time or skill to do it, so if anyone can implement a search feature on the docs, I will appreciate it.

Preferably without Algolia or other third-party services

Some resources ideas to start with (go ahead if you have other ideas):

@Hans5958 Hans5958 added scope: docs Related to the documentation (Scratch Addons Docs) scope: engine Related to the scripts and Hugo stuff of the website type: enhancement New feature or request help wanted Extra attention is needed labels Mar 5, 2022
@cobaltt7
Copy link
Contributor

cobaltt7 commented Mar 5, 2022

fuse is actually horrible tbh, the results are not accurate at all

see, this search returns nothing because i didn't use double quotes
image

@mxmou
Copy link
Member

mxmou commented Mar 6, 2022

see, this search returns nothing because i didn't use double quotes

A single quote means "include-match" according to the documentation, but I don't know how that's different from just typing the word.

A more serious problem is that even if extended search is enabled (without it, you have to enter the words in the same order as they appear in the result), you can only search individual fields.
image
image
image

For documentation search, that would mean "joining volunteer localization" would return no results because "joining" only appears in the title and "volunteer" only appears in the page content.

@Hans5958
Copy link
Member Author

Hans5958 commented Mar 6, 2022

Yeah, it was just my random idea based on the current implementation on Scratch Addons. If anyone knows better libraries then go ahead.

@Hans5958
Copy link
Member Author

Hans5958 commented Mar 10, 2022

@Weredime
Copy link
Contributor

Preferably without Algolia

:(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed scope: docs Related to the documentation (Scratch Addons Docs) scope: engine Related to the scripts and Hugo stuff of the website type: enhancement New feature or request
Projects
Status: Long Term
Development

No branches or pull requests

4 participants