TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

JQuery's API documentation gets a redesign

128 pointsby jordeover 12 years ago

23 comments

akamakaover 12 years ago
Not a fan of this redesign.<p>-What happened to the comments? That was one of the most useful features of the old documentation, and I constantly relied on them to find examples or clarify edge cases.<p>-The code samples are on opposite colored backgrounds, which makes the whole page extremely painful to read. Can you imagine reading paper book that had code samples written in white text on a black background? How is that a good idea on the web?<p>-The huge blue border around the edge adds even more visual noise.<p>-Why is so much stuff laid out inside of boxes, starting with the list of functions? Developers are experts at reading raw blocks of text, so minimal formatting is needed.<p>-Finally, where did the old documentation go? The content has been changed, but where can we find it? There doesn't seem to be any links.<p>The old documentation definitely needed some work, but these improvements have brought with them new problems, and overall I find it harder to use than before.<p>Edit:<p>Compare Google's documentation: <a href="https://developers.google.com/maps/documentation/javascript/tutorial" rel="nofollow">https://developers.google.com/maps/documentation/javascript/...</a><p>While not perfect, it does a lot of things right: no extraneous formatting around the page edges, solid background, clean code examples, and importantly, access to old versions of the documentation.
评论 #5024638 未加载
评论 #5024459 未加载
评论 #5025045 未加载
mustardamusover 12 years ago
FYI, I am working on a revamp of jQAPI, a alternative browser for the documentation. Should be released pretty soon.<p><a href="http://pre.jqapi.com/" rel="nofollow">http://pre.jqapi.com/</a> <a href="https://github.com/jqapi/jqapi" rel="nofollow">https://github.com/jqapi/jqapi</a>
评论 #5022326 未加载
评论 #5022914 未加载
评论 #5023597 未加载
评论 #5023281 未加载
评论 #5022913 未加载
ecaronover 12 years ago
I would have liked it the jQuery API documentation would be closer to the PHP.net documentation. For instance, I want to know the options for $.post - going to <a href="http://api.jquery.com/post/" rel="nofollow">http://api.jquery.com/post/</a> would sure be nice (and even if it didn't exist, it could do a search for "you might have meant...")<p>For people unfamiliar with PHP.net's configuration, going to php.net/&#60;function or whatever name&#62; will go to the function if its known or search if it isn't (like <a href="http://php.net/strapos" rel="nofollow">http://php.net/strapos</a>)
评论 #5021745 未加载
评论 #5021725 未加载
评论 #5022229 未加载
评论 #5022175 未加载
评论 #5021831 未加载
fredleyover 12 years ago
I like the idea, but it's far more spread out than the previous design, and it's a bit much for me. I wish there was a google-like 'cosy' setting allowing me to compress things back a bit.
sebnukem2over 12 years ago
<i>Every</i> redesign on the web boils down to having less information on the viewport, requiring more scrolling, thanks to bigger font and wasted "Comfortable" spaces. It drives me crazy.<p>At least Google offers you a "Condensed" layout.
Glenchover 12 years ago
Man, how about finishing that jQuery plugins site instead of a redesign? :)
评论 #5021702 未加载
评论 #5023425 未加载
cgarveyover 12 years ago
Nice update! Much appreciated improvements.<p>The only thing I noticed that was weird is the search box seems to have different behavior between the instant results and the results you receive when you hit &#60;enter&#62;. Not sure if this is intended, but the instant results seem to be limited to whatever categorical scope you're in.
r4vikover 12 years ago
This is still slow as shit, why? It seems to be running under php when the whole thing could've been generated with jekyll and maybe even pjax'd to make navigation even quicker.
评论 #5021716 未加载
评论 #5021926 未加载
评论 #5023636 未加载
DigitalSeaover 12 years ago
I might not be in the majority here, but I like the redesign. Some of the entries might not be as complete, but I'm glad the comments section is gone because lets face it rarely was there anything useful in the comments, this isn't php.net.
bluetideproover 12 years ago
Overall, this is a great update for the jQuery docs! It feels much more clean, and is a lot easier to navigate. My only complaint would be the dark code blocks, does it bother anyone else's eyes?
评论 #5021453 未加载
gabipurcaruover 12 years ago
If you ask me, making the old one faster would have been much better; I don't go there for the nice design, I go because I have stuff to get done, and I'd rather get that stuff done fast.
mrharrisonover 12 years ago
This was so needed, don't know why people are hating, it's much easier to read and browse through. Thanks for the update.
ckarmannover 12 years ago
I don't know if I am alone, but having no global view of methods in a category without scrolling down is a noticeable loss of productivity for me. I, too, would prefer a "cosy" setting of some sort.<p>When people start to make cheatsheets then it means your documentation lacks some bird's eye view...
conradfrover 12 years ago
The logo does not waste enough screen estate.
garraethover 12 years ago
Were comments removed or is it just me that can't see them?
评论 #5024921 未加载
nestlequ1kover 12 years ago
Sorely needs a bit more line height on the doc content. Terribly unreadable all bunched together.
imjaredover 12 years ago
This is a nice looking redesign but I think I'll probably stick to jqapi.com for quick reference. It's fast, I can find methods by URL (eg. jqapi.com/#p=get), and search auto-completes.
TommyDANGerousover 12 years ago
It looks nice, but the previous design was excellent. It had more examples, more detailed explanations, and lots of comments. I'll just have to get use to this.
fourstarover 12 years ago
Has been in development for awhile so I'm glad to see the team finally got it live. Although the jQuery UI docs page is still pretty ugly.
jakozaurover 12 years ago
Neat!<p>How about adding a link which will let you experiment using jsbin (or sth similar) with the code examples?
xsaceover 12 years ago
This is what I use: <a href="http://oscarotero.com/jquery/" rel="nofollow">http://oscarotero.com/jquery/</a>
评论 #5022720 未加载
teekover 12 years ago
$(".post").css("background-color","inherit").css("border",0);
johnmurray_ioover 12 years ago
The code-examples look awful in Chrome on Windows... :-[
评论 #5022190 未加载