jQAPI 3.0.1
Alternative jQuery Documentation Browser
What is this?
This is a alternative interface to browse the Official jQuery Documentation. It was created to get out of your way of your development work - quickly find what you are looking for, easy on the eyes, and lightning fast. Just start typing and see for yourself!
Features
- Content is the same as in the Official jQuery Documentation
- Statically rendered pages powered by Astro, so the initial loading time is super fast
- Subsequent page loads are done via Ajax, so it's even faster
- Navigation structure with (sub)categories and entries is the same as in the official docs
- Search to quickly filter for methods and selectors
- Keyboard navigation, hover the keyboard icon in the search bar for a reference
- Code examples (JS, HTML, CSS) are formatted with Prettier and highlighted with Prism
- Live examples right in the browser
- Page content is prettily styled by Bulma
- Coming soon Mobile friendly navigation
- Coming soon Offline browsing
- Coming soon Dark theme
If you find any bugs or want to make feature suggestions, head over to the GitHub Issues. Pull requests are welcome as well. Thanks!
History
The first jQAPI came to be in 2010, heavily inspired by the similar RailsAPI (now defunct), a alternative interface to browse the Ruby on Rails Documentation. The very first version was hacked together in a weekend, and since people were really digging it, a more stable version followed quickly.
In 2013 I revamped jQAPI once again, and it has been online ever since. These fine folks supported the development back then via crowdfunding:
Joseph Huckaby, Rory Craig-Barnes, Nathan Perkins, Tobias Otte, Alan Faubert, Alex Kulikov, Dana Woodman, Roman Amir Shamsuddin, David Corbacho, Josh Pangell, Andrew Hahn, Yoren Chang, codeworxx, Steven Olsen, Brock Adams, Simen Svale, Skogsrud Mironov, Mikhail Geoffrey, Doret Johan Hermansson, and Tim Osborn
Starting 2023, the site went down for a period of time, due to hosting migration. People started messaging me what's up, and how they could help to bring it back online. Inspired by the fact that people still use a project that I started 13 years ago, I coded the next version of jQAPI, the one you see here. I hope you like it!
Built with
jQuery, jQuery Documentation, Astro, Bulma, Prettier, Prism, Sass, And more...
License
jQuery's documentation is licensed with CC0.
jQAPI is Open-Source and licensed with MIT. jQAPI is coded by Sebastian Senf. Follow me at @mustardamus.
Changelog
Follow @jQAPI for updates.
- 2023-01-23 Released jQAPI V3, complete rewrite based on Astro.
- 2014-02-11 Updated documentation. TODAY IS THE DAY WE FIGHT BACK AGAINST MASS SURVEILLANCE.
- 2013-07-09 Docs generation fixed. (By John Foley) - Updated documentation.
- 2013-03-19 XML parsing fixed. (By Ilan Frumer) - Updated documentation.
- 2013-01-21 jQAPI is again available as stand alone AIR app.
- 2013-01-21 Don't set focus on search field on mobile devices if pointer is over the sidebar.
- 2013-01-18 Find best matching entry on search, and put it on first position.
- 2013-01-15 Relative paths so you can store the offline jQAPI in a subfolder. (By Klortho)
- 2013-01-10 Released the revamped and better jQAPI.
- 2011-xx-xx Documentation updating and some bug fixing.
- 2010-03-10 Major code refactoring.
- 2010-01-31 Complete rewrite for the masses.
- 2010-01-29 Released very first version.