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

Implemented Algolia search #4884

Merged
merged 6 commits into from
Jun 13, 2021
Merged

Implemented Algolia search #4884

merged 6 commits into from
Jun 13, 2021

Conversation

leroy
Copy link
Contributor

@leroy leroy commented Apr 29, 2021

Implements Algolia search as discussed in #4461

@Calinou Calinou added enhancement content:website Issues related to adding website features and fixing bugs, whether on the front or back-end labels Apr 29, 2021
conf.py Outdated Show resolved Hide resolved
@leroy leroy requested a review from Calinou May 8, 2021 07:55
_static/css/algolia.css Outdated Show resolved Hide resolved
@leroy
Copy link
Contributor Author

leroy commented Jun 12, 2021

@Calinou

Hey :)

Do you need me to do anything to get this PR merged?

@Calinou
Copy link
Member

Calinou commented Jun 12, 2021

@leroy There are merge conflicts to solve in requirements.txt. I can merge it once this conflict is resolved. Apologies for the delay; I work on a lot of things in parallel.

@leroy leroy requested a review from Calinou June 13, 2021 14:28
@leroy
Copy link
Contributor Author

leroy commented Jun 13, 2021

Hey no worries at all. I've resolved the merge conflicts.

Copy link
Member

@Calinou Calinou left a comment

Choose a reason for hiding this comment

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

Thanks!

@Calinou Calinou merged commit 6ae96e7 into godotengine:master Jun 13, 2021
@Calinou
Copy link
Member

Calinou commented Jun 13, 2021

It seems to work on the latest branch:

image

There are some things we need to improve still:

  • Pressing the Enter key while the field is empty shouldn't do anything, since it will redirect you to a standard search page with no results found.
  • ref badges should be placed on the same line as the page name (at the left of the page name), rather than on a separate line. Right now, class reference and non-class reference pages tend to blend in together, which isn't good for people who want to avoid class reference pages.
  • The search pop-up should have a dark theme when the documentation uses the dark theme (defined via CSS' prefers-color-scheme: dark media query).
    • As a crude solution, adding filter: invert(87.5%) hue-rotate(180deg) to the search pop-up does the work surprisingly well:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content:website Issues related to adding website features and fixing bugs, whether on the front or back-end enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants