Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation
https://redocly.github.io/redoc/
MIT License
23.31k stars 2.29k forks source link

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

Closed darklynx closed 7 years ago

darklynx commented 8 years ago

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 commented 8 years ago

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 commented 8 years ago

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

erlend-sh commented 7 years ago

+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 commented 7 years ago

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

RomanHotsiy commented 7 years ago

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