jquery-tmpl icon indicating copy to clipboard operation
jquery-tmpl copied to clipboard

Add API Documentation to README

Open ajpiano opened this issue 13 years ago • 5 comments

The docs for jQuery.tmpl are no longer included in api.jquery.com, and I don't foresee us adding them back to there. I think the best solution is to just include the API documentation in the README, as is popular for many open source projects of similar scale and complexity as jQuery.tmpl. Although the plugin is deprecated, it seems many are still reliant on it and the documentation should be somewhere.

This issue is essentially porting over @listrophy's tweet from earlier today, so thanks for that. https://twitter.com/listrophy/status/289041726864240640

ajpiano avatar Jan 09 '13 17:01 ajpiano

+1

rdworth avatar Jan 09 '13 17:01 rdworth

+1 I needed this today, but.. =/

felquis avatar Jan 14 '13 13:01 felquis

If anyone is still interested in this, I've submitted a pull request that should go towards correcting the issue. https://github.com/jquery/jquery-tmpl/pull/175

waynedenier avatar Jan 28 '13 20:01 waynedenier

Very nice. Thanks Wayne. This leads the way. :). This is one topic, from the 13 that are listed here, so logically, this process could be continued to add the other twelve. (And then, for more fun, adding in the demos :))

I know a lot of folks are missing the docs a lot, so this is great. I did receive an email suggesting I add the docs to my blog, which could also be an option. Otherwise just adding to this README might be fine, especially if navigation between topics can be included, as hash anchor links, within the readme.md document... Maybe we should keep this issue open, since so far we just have one documentation topic out of 13.

BorisMoore avatar Jan 28 '13 20:01 BorisMoore

I have changed the README and provided a link to the archived documentation. See https://github.com/BorisMoore/jquery-tmpl/issues/177

BorisMoore avatar Oct 07 '16 17:10 BorisMoore