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

Algolia's DocSearch ready! ✨ #120

Merged
merged 2 commits into from
Nov 8, 2017
Merged

Conversation

LukyVj
Copy link
Contributor

@LukyVj LukyVj commented Nov 6, 2017

Hello guys!

I'm happy to announce that this is the final PR for the DocSearch implementation on Tailwind.css!
So, a few stuff to share with you, I added a few more files in order to have the best implem ever!

But first, let see what happen here.

I removed the "sidebar header" from the sidebar scope, because sidebar got a class that handle the scroll on the y axis if there is too much content. Therefore, the x axis is hidden, and because of that, the docsearch dropdown couldn't be visible.

So I had to remove the header from the sidebar, even tho the look'n'feel is the same ( see here master...LukyVj:master#diff-70b205842e0adc80d56e2ce469aadd47R8 )

To make sure this sidebar doesn't overlap the header, I had to create a new less file, called sidebar.less which only purpose is to offset the sidebar from top. Otherwise it would hide the header.

I added also a file called docsearch.less which handle the color & responsiveness of the DocSearch dropdown.

Talking about responsive, you'll notice 2 DocSearch declarations ( here : master...LukyVj:master#diff-2802ff3e03db6b3656a5fc4e9b9467a5R30 )

And this is for reducing the amount of specific css that would have been required to adapt and reposition the search input on mobile. So this is an equivalent of having a multiple input for docsearch, which is being implemented right now.

So expect a PR really soon, that will remove the double DocSearch instance, and being replaced by
inputSelector: '#searchbox, #searchbox-mobile'

I think that's pretty much it, feel free to ping me for anything you could need, or if you need me to change something. I'll be glad to do that for you!

Lucas B & the Algolia team

@LukyVj LukyVj mentioned this pull request Nov 6, 2017
@reinink
Copy link
Member

reinink commented Nov 6, 2017

@LukyVj Awesome, thanks so much! We'll get this fixed up and merged in. I really appreciate your help. 💪

apiKey: '3df93446658cd9c4e314d4c02a052188',
indexName: 'tailwindcss',
inputSelector: '#searchbox-mobile',
debug: true
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is debug enabled here?

Copy link

@Diddyy Diddyy Nov 6, 2017

Choose a reason for hiding this comment

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

@mdavis1982 It's set to true to enable the inspection of the dropdown menu's CSS.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call! My bad, you can just remove it! Indeed it’s useful to when you need to inspect the dropdown. I forgot to remove it 😊

Copy link
Contributor

Choose a reason for hiding this comment

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

@Diddyy I think you tagged me by mistake here 😄

@ghost
Copy link

ghost commented Nov 8, 2017

This will also close #58!

@reinink reinink merged commit 4f866c5 into tailwindlabs:master Nov 8, 2017
@reinink
Copy link
Member

reinink commented Nov 8, 2017

This has been merged! 🎊

One question @LukyVj: Is there anyway for us to view any analytics for DocSearch? Like, is there a control panel? I'm assuming no, but I figured I would ask.

Also, is there anyway to tweak the search settings? For example, right now if I search for "uppercase", I get no results. However, we definitely have "uppercase" in our docs: http://tailwindcss.dev/docs/text-style. Any suggestions would be much appreciated! ❤️

image

@LukyVj
Copy link
Contributor Author

LukyVj commented Nov 8, 2017

Hey @reinink

One question @LukyVj: Is there anyway for us to view any analytics for DocSearch? Like, is there a control panel? I'm assuming no, but I figured I would ask.

There is a way to have analytics! Let me reach out to you by email!

And thanks for the support!!!!!!

@reinink
Copy link
Member

reinink commented Nov 8, 2017

@LukyVj AMAZING! ❤️

Also, searching for "uppercase" appears to be working now.

winning

@adamwathan
Copy link
Member

Hey @LukyVj! I shipped a redesign of the docs the other day and am noticing now that I've broken the categories that used to appear in the left column of the search results 😬

image

Is there any way for me to fix this myself? Feel bad bugging you to do it for me!

@LukyVj
Copy link
Contributor Author

LukyVj commented Feb 27, 2018

Hey! Sure, I can take a look and debug it tomorow!
But, seems like the tailwind website is broken / does not load for now!

@adamwathan
Copy link
Member

Unfortunately a DNS outage messed up a ton of stuff for anyone using Hover for their domains :/ Apparently switching off of Google's DNS fixes it for most people; right now it's just a matter of waiting out the caching game.

@LukyVj
Copy link
Contributor Author

LukyVj commented Feb 28, 2018

So, I'm investigating, but seems like the content of the left column is just not here, I'm gonna find out why :)

@LukyVj
Copy link
Contributor Author

LukyVj commented Feb 28, 2018

Did you changed some DOM structure? The possible issue would be that the config we made for Tailwindcss at the time, is no longer working with a new website structure.

@adamwathan
Copy link
Member

Yeah big time, I redesigned the whole site 😅Sorry! 😔

@LukyVj
Copy link
Contributor Author

LukyVj commented Feb 28, 2018

No worries! We are working on fixing it! I'll let you know ASAP :)

@LukyVj
Copy link
Contributor Author

LukyVj commented Feb 28, 2018

I'll let @s-pace fix this for you :)

s-pace pushed a commit to algolia/docsearch-configs that referenced this pull request Feb 28, 2018
@s-pace
Copy link

s-pace commented Feb 28, 2018

👋 ,

Done ✅, you can have a look here

Already deployed and solved (check it, it's live)

Feel free to ping us at any time if you need help or if you have any feedback.

Cheers

@s-pace
Copy link

s-pace commented Feb 28, 2018

Btw, we do provide analytics 📊 on your DocSearch index 📝
Please provide me the emails ✉️ of the collaborators 👥 to add to our analytics dashboard 😄

@adamwathan
Copy link
Member

Amazing, thank you!

DCzajkowski pushed a commit to DCzajkowski/tailwindcss that referenced this pull request Jul 23, 2019
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.

None yet

7 participants