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 search functionality for docs #21

Merged
merged 19 commits into from Mar 17, 2019

Conversation

Projects
3 participants
@allejo
Copy link
Member

commented Mar 11, 2019

Since we're a static site and we need a way to be able to search the documentation, a JS-based version is the best way to go. I'm using Lunr.js for indexing all our collections and rendering it all through good old vanilla JS.

Task List

  • Add Search link or input field throughout the site and navigation

Closes #19

allejo added some commits Mar 10, 2019

@allejo allejo self-assigned this Mar 11, 2019

@allejo allejo added this to In progress in Website Redesign via automation Mar 11, 2019

@allejo allejo requested review from blast007 and jwmelto Mar 11, 2019

allejo added some commits Mar 11, 2019

Use <noscript> instead of a .hide-js class
Using the .hide-js class will cause a flicker on the page as JS starts
where <noscript> will not.

@allejo allejo added the blocked label Mar 12, 2019

@allejo

This comment has been minimized.

Copy link
Member Author

commented Mar 12, 2019

Marking as blocked for now while we investigate more; see olivernn/lunr.js#370

Basically, searching *compiling* will not return the same results as searching compiling. This appears to be a lunr.js bug. We would need to find a fix or a workaround.

@allejo allejo removed the blocked label Mar 14, 2019

blast007 and others added some commits Mar 14, 2019

Manually set page title for page history
...because apparently browsers ignore the title argument for some reason

see: whatwg/html#2174

@allejo allejo force-pushed the feature/redesign/search branch from 88eeba5 to f66a602 Mar 14, 2019

@jwmelto

This comment has been minimized.

Copy link
Member

commented Mar 16, 2019

I'm not qualified to review this, since I'm not familiar with these technologies. I'm marginal in raw Javascript. I don't see anything that jumps out at me.

allejo added some commits Mar 16, 2019

@allejo allejo merged commit 3f9334e into redesign Mar 17, 2019

Website Redesign automation moved this from In progress to Done Mar 17, 2019

@allejo allejo deleted the feature/redesign/search branch Mar 17, 2019

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