jQAPI - Alternative jQuery Documentation - For Version 1.6

Why another jQuery Documentation?Solving your own problems is so much fun.

There are numerous alternative jQuery documentations out there, such as jQuery API Browser, jQuery API, Visual jQuery and another jQuery API Browser. They are all out of date. The latest official documentation has been released in the 14 days of jQuery. Why the heck another one?

The jQuery documentation is great, very complete, nicely written and with a lot of examples and demos. The only thing that bugs me is the way we have to find the right documentation for what we search for. Try to search for the .is() function for example. Over 100 matches before the actual function I am looking for?!*) And it is a fixed layout which means even on my big screen I have to scroll all the way down and have to scan for it. There have to be a better way, obviously.

The alternative Rails documentation Rails API is my favorite documentation for my favorite server-side tool. Unfortunately my favorite client-side tool did not have such a fast and slick documentation. Inspired by the Rails API and desperate for a better navigation I coded one myself. Of course with jQuery!

Just to make it clear, I only coded the navigation and re-styled the documentation. The content is the same as in the official documentation and all credits belong to the jQuery team. Keep up the great work!

*) Edit: it is the first search result when you enter it with brackets.

Keyboard UsageSpeed it up.

The keys are working if the search field has focus or your mouse cursor is in the navigation area. ESC key is global.

UP      - Previous category / Previous item
DOWN    - Next category / Next item
ENTER   - Open category / Load selected item
ESC     - Clear search field and set focus

CreditsAnd props.

To DoWhat is still on the list.

  1. Fix links to other pages.
  2. Make a page for the different return types and fix the links.
  3. Auto scroll the navigation when keys are used.

ContactAka 'I haven't found another place to stick all the links I want you to go to'.

Coded by Julying (@julying)