What is jQAPI
As great as jQuery is, its online documentation lacks of usability. I don't say it's bad, but in your daily development work you want to be distracted as little as possible. Hence I developed jQAPI in 2010, the idea was to switch to the browser and quickly find what you are looking for and get back to work.
I created jQAPI for my needs. It was never intended to be more than a small project but people started to like it. Now it's the jQuery documentation for thousands of people in their daily work.
I think it's save to say this project deserved to be revamped. The moment couldn't be better. I need your help to make it possible.
Some stats and facts about jQAPI
jQAPI is nearly three years old and was hacked together in two days.
There are 1000-1200 people visiting on working days. The average duration of visits is 17 minutes. Some are there for hours though :).
This project was featured on HackerNews twice sending one day 15k and the other 7k visitors to explore jQAPI.
Over the time period of three years this little project had 760k visits.
There are also translations for jQAPI, respectively the official documentation. The good people over at http://jqapi.com.br/ for example translate the docs to Portuguese and present it with jQAPI. Maybe this fresh start will be an opportunity to create a better structure for multi language support.
Most recently I received the domain visualjquery.com (which is a API browser as well, but not maintained anymore) from the nice people maintaining jQuery. This old domain will redirect to jQAPI in future exposing the project to more people.
9 Things to make jQAPI the best way to browse the jQuery Documentation
Rewrite from scratch
I released jQAPI nearly three years ago and did one major update after the first year. Ever since I just updated the documentation and fixed some bugs.
Two years later I have a better idea about that whole web development thing. With that better understanding I want to rewrite it from scratch for speed and usability.
I will create a more friendly setup to develop for jQAPI so maybe some people will jump on and help making it the best documentation browser out there. This project will of course be open-source and hosted at GitHub.
A long awaited feature. Syntax highlighting for the demos: JS, HTML and CSS.
Sandboxes to play around
You will be able to play around with the demos. Edit the code and see the live demo update. The quickest way to try out some code.
Better Search Bar
I plan to implement a improved search bar with fuzzy searching. So you really get what you are searching for, be it categories, selectors or methods.
Filter by jQuery Version
In the current state jQAPI only shows the documentation for the latest version of jQuery. In future you will be able to filter the methods & co. by the version when they were introduced.
A loved feature about jQAPI is that you can download the whole package and browse it offline. With the new jQAPI you have the choice between downloading and the new HTML5 offline features. You don't even need to download it! Just use the sync feature and browse to jqapi.com with a modern browser when offline.
Often you search for a method to find out how it's invoked or what the callback arguments are, etc. With a nicely structured and searchable cheatsheet of jQuery on the first page of jQAPI your search time will maybe reduced even further.
Change the Favicon
Here is a fun fact: The Favicon of jQAPI is Chinese (I knew that) and can also mean 'penis' (didn't knew that). Ever seen a penis-icon running for three years? Yes yes, time to change that :).
Where is your money going
I use the money to lay off my freelance web development work for 2-3 months and exclusively develop the next version of jQAPI.
It will benefit thousands of people around the globe already using jQAPI in their daily work. And it will potentially benefit many more once the project is in a nice shape and driven by the community.
When will it be ready
Pretty soon I hope. I will develop and release the features described above incrementally. First thing that will be done is to rewrite jQAPI to function exactly like the old one. With all benefits a fresh start brings with it.
I plan to have all features released by January 30th 2013. That's exactly three years after the first code commit to this project.
What people say about jQAPI
@mustardamus Dude GREAT job with jQAPI
Found jqapi.com tonight and basically I love you all
Developer in the first place