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 in-page search with result highlighting (feature request) #51

Closed
darklynx opened this issue May 18, 2016 · 5 comments
Closed

Add in-page search with result highlighting (feature request) #51

darklynx opened this issue May 18, 2016 · 5 comments

Comments

@darklynx
Copy link

darklynx commented May 18, 2016

It would be great to implement an in-page search with results highlighting similar to something available here: http://docs.fidor.de (just enter the word "unique" within the search input field and click on one of the found references)

If you look at http://docs.fidor.de/javascripts/all.js there are a lot of open source JavaScript libraries that helps to implement search and highlight the results, like:

Looks like it is possible to implement an in-page search with support from those libraries that would add a lot of credits to the wonderful ReDoc project! This may become a killing feature of the project ;)

Thank you in advance!

@darklynx
Copy link
Author

darklynx commented May 18, 2016

P.S. they are using https://github.com/gfranko/jquery.tocify.js for TOC, i'm not sure what is used in ReDoc, but it shouldn't be difficult to expand TOC and include the search results on top: the concept of in-page search implemented by developers of http://docs.fidor.de is really neat.

@RomanHotsiy
Copy link
Member

@darklynx, great idea. We liked it.
It's definitely something to consider for after-1.0 releases.

@erlend-sh
Copy link

+1 to this from us at Discourse as well. We're building a new API docs site with ReDoc. Here's the WIP:

http://blakeerickson.com/discourse_api_docs/

Thanks for a great product!

@RomanHotsiy
Copy link
Member

@erlend-sh I have great news: this feature is coming soon. I've already started working on it.

@RomanHotsiy
Copy link
Member

The feature is implemented now 🎉 🚀
@darklynx thanks for patience 😂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants