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

[documentation] Add a nice search experience to the website #416

Merged
merged 5 commits into from Sep 5, 2018

Conversation

@s-pace
Copy link
Contributor

commented Aug 28, 2018

This PR will add DocSearch to the documentation website. It will allow an user to have a learn-as-you-type experience by displaying results thanks to a dropdown in a live way.

If there is no result, pressing enter will enable the legacy search.

Ref Bootstraping PR as jquery/api.jquery.com#1104

Component: Add DocSeach to jquery website
This commit will add DocSearch to the documentation website. It is the first step in order to fully integrate it.

Ref Bootstraping PR as jquery/api.jquery.com#1104
@jsf-clabot

This comment has been minimized.

Copy link

commented Aug 28, 2018

CLA assistant check
All committers have signed the CLA.

@s-pace

This comment has been minimized.

Copy link
Contributor Author

commented Aug 28, 2018

You can wait for our green light.

We will do an internal check in order to provide you a final PR soon

@s-pace s-pace force-pushed the s-pace:adding_docsearch branch from 3ced3de to 892ba08 Aug 28, 2018

s-pace added some commits Aug 29, 2018

Component: Add DocSeach better integrated into jquery website
This commit will enhance the includes by moving it to the end of the page
@s-pace

This comment has been minimized.

Copy link
Contributor Author

commented Aug 29, 2018

On iPhone X:
iPhone X

On iPad:
iPad

On desktop:

desktop

Live demo of this PR

Please review it :)

@mgol
Copy link
Member

left a comment

A few remarks, otherwise looks good.

One thing I couldn't comment inline - please don't add the .DS_Store file to the repository.

indexName: 'jquery',
inputSelector: 'input[name=\'s\']',
debug: true // Set debug to true if you want to inspect the dropdown
})" async></script>

This comment has been minimized.

Copy link
@mgol

mgol Sep 5, 2018

Member

We use tabs for indentation in this file, can you update it? Also, what's inside of the object should be indented more than the closing parens.

This comment has been minimized.

Copy link
@s-pace

s-pace Sep 5, 2018

Author Contributor

Sure! Done

@@ -0,0 +1,16 @@
/* Custom DocSeach CSS to adapt the generic one * See https://community.algolia.com/docsearch/styling.html for more info */
nav#main .searchform {
text-shadow: none;

This comment has been minimized.

Copy link
@mgol

mgol Sep 5, 2018

Member

Please use tabs, not spaces.

@s-pace

This comment has been minimized.

Copy link
Contributor Author

commented Sep 5, 2018

Thank you for the guidance @mgol.
Sorry for the .DS_Store, removed
Let us know if you need anything else

@@ -0,0 +1,19 @@
/* Custom DocSeach CSS to adapt the generic one * See https://community.algolia.com/docsearch/styling.html for more info */
nav#main .searchform {
text-shadow: none;

This comment has been minimized.

Copy link
@mgol

mgol Sep 5, 2018

Member

This file still uses spaces, please change to tabs.

This comment has been minimized.

Copy link
@s-pace

s-pace Sep 5, 2018

Author Contributor

My bad. fixed

@mgol

mgol approved these changes Sep 5, 2018

Copy link
Member

left a comment

Looks good to me, thanks!

@mgol mgol merged commit 495f31a into jquery:master Sep 5, 2018

1 check passed

licence/cla Contributor License Agreement is signed.
Details
@mgol

This comment has been minimized.

Copy link
Member

commented Sep 5, 2018

I've tested it now on https://api.jquery.com/ and it works absolutely awesome; such a nice experience. Wonderful work, thanks a lot! 👏

@dmethvin

This comment has been minimized.

Copy link
Member

commented Sep 5, 2018

THIS IS AWESOME! 🎉 Many thanks @s-pace, and @mgol for getting this landed. Much better than the old search.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.