-
Notifications
You must be signed in to change notification settings - Fork 414
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
Initial search implementation (fullwidth-only) #626
Conversation
…ist of all declaration names, their parent declaration name and abstracts, meant for indexing in lunr.js
Generated by 🚫 danger |
@@ -0,0 +1,22 @@ | |||
require 'tempfile' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This appears to be unused
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@esad: Any comments? Can we get this removed?
IMO, this is the only reasonable way, I'm 👍 with that
I'm for it ( I'll be doing so for CocoaDocs when I can )
This one I'm less sure of, someone else may have a better sense, I guess the thing here is that if you're reading it via Dash or Xcode's inline reader - they have their own searches, so maybe the these can take those into account and not show the search input there?
I've read issues about React-ifiying the theme, but that might be engineering effort that might be worth saving for a separate PR |
Merged in #725. |
I wanted to get early feedback on how to best integrate the search feature (See #14) that we described in our blog post.
This PR adds support for dumping
search.json
index if the--searchable
configuration flag is set, as well as actually searching this index (via lunr.js) and displaying the matches in the "fullwidth" theme.I've generated Realm ObjC docs with this branch, you can see it in action here.
Couple of questions:
--searchable
per default?file://
URLs)? Some browsers (Chrome) don't support XHR requests from file:// URLs so we'd have to figure out a different way of downloading the index.