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

Make functions in docs filterable #2514

Merged
merged 1 commit into from
Apr 29, 2016
Merged

Commits on Apr 25, 2016

  1. Make functions in docs filterable

    With a utility library like Underscore, it is very common to open the docs with
    the aim of locating the documentation for a specific function.
    
    Currently I use my browser's search functionality, but since many functions
    reference other functions, I frequently have to cycle through multiple matches
    before I arrive at the actual function's description.
    
    This patch aims to improve this common use case by offering a "filter" input
    above the list of functions. As a user types, the list of functions (and
    section titles) is reduced, leaving only the matching functions. If the user
    presses enter, they are jumped to the documentation for the first matching
    function.
    
    This functionality (and implementation) is greatly inspired by the
    implementation that is included in the [Ramda docs](http://ramdajs.com/0.21.0/docs/).
    
    You can read their source code [here](https://github.com/ramda/ramda.github.io/blob/master/main.js)
    captbaritone committed Apr 25, 2016
    Configuration menu
    Copy the full SHA
    ef9ee4b View commit details
    Browse the repository at this point in the history