jsduck alternatives and similar libraries
Based on the "Documentation" category.
Alternatively, view jsduck alternatives based on common mentions on social networks and blogs.
-
Beautiful docs
Pointers to useful, well-written, and otherwise beautiful documentation. -
codecrumbs
Learn, design or document codebase by putting breadcrumbs in source code. Live updates, multi-language support and more. -
styledocco
Automatically generate a style guide from your stylesheets. -
dexy
is a free-form literate documentation tool for writing any kind of technical document incorporating code. -
ip-num
A TypeScript/JavaScript library for working with ASN, IPv4, and IPv6 numbers. It provides representations of these internet protocol numbers with the ability to perform various IP related operations like parsing, validating etc. on them -
coddoc
is a jsdoc parsing library. Coddoc is different in that it is easily extensible by allowing users to add tag and code parsers through the use of coddoc.addTagHandler and coddoc.addCodeHandler. coddoc also parses source code to be used in APIs. -
DevDocs
is an all-in-one API documentation reader with a fast, organized, and consistent interface.
SurveyJS - Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of jsduck or a related project?
Popular Comparisons
README
Warning: JSDuck is no more maintained!
- If you're looking to adopt a documentation tool, try something else.
- If you're using JSDuck, consider moving over to something else.
- Even Sencha itself doesn't use it any more, they use some internal tool, that's not available publicly.
- If you'd like to take over the maintenance of JSDuck, contact me by creating an issue.
API documentation generator for Sencha JavaScript frameworks.
JSDuck aims to be a better documentation generator for Ext JS than the old ext-doc was. It is used by Sencha to document Ext JS 4, Sencha Touch and several other products.
The highlights of JSDuck are Markdown support and keeping you DRY by inferring a lot of information from code. Read the documentation for full overview.
New to JSDuck? Watch introductory talk by Nick Poulden:
Getting it
Standard rubygems install should do:
$ [sudo] gem install jsduck
Or download the Windows binary. When you run into problems, see the installation guide.
Usage
For the simplest test-run just use the --builtin-classes
option to
write documentation for JavaScript builtin classes like Array, String
and Object into docs
directory:
$ jsduck --builtin-classes --output docs
To generate docs for Ext JS 4 add path to the corresponding src/ dir:
$ jsduck ext-4.2.1/src --output docs
And to create docs for your own Ext JS project, list the directory with your files in addition to the Ext JS source files (this way the docs of your classes will list all the properties and methods they inherit from Ext JS classes):
$ jsduck ext-4.2.1/src my-project/js --output docs
Unfortunately the above will throw lots of warnings at you, as building the full Ext JS docs requires lots of additional settings. For start you might want to simply ignore all these warnings originating from Ext JS source:
$ jsduck ext-4.2.1/src my-project/js --output docs \
--warnings=-all:ext-4.2.1/src
But see the Usage guide for more information on building Ext JS 4 docs.
Documenting your code
Read the documentation and take a look at example.js.
Hacking it
See Hacking guide in wiki.
Who's using JSDuck?
- Appcelerator Titanium SDK
- AT&T API Platform SDK for HTML5
- Bryntum Siesta unit testing framework
- CKEditor
- GeoExt 2
- Rally Software Rally App SDK
- Wikimedia Foundation MediaWiki and VisualEditor
- Sencha - obviously :)
These are some that we know of. Want your project listed here? Drop us a line.
Copying
JSDuck is distributed under the terms of the GNU General Public License version 3.
JSDuck was developed by Rene Saarsoo, with contributions from Nick Poulden, Ondřej Jirman, Thomas Aylott, Dave Thompson, Ed Spencer, Rob Dougan, Scott Whittaker, Timo Tijhof, Brian Moeskau, Garry Yao, Yasin Okumus, Nicholas Boll and Katherine Chu.
Many thanks goes also to those who have most eagerly reported bugs: Ryan Nauman, Raphael Franchet, atian25, burnnat, Raphael Pigulla, Dmitry Bakaleinik, Alan Lindsay, Corey Butler, Nickolay Platonov, Matt Greer, Richard and Dmitry Pashkevich.
There are lots of others I haven't named here, who have provided their input.
Changelog
See the Releases page.
More questions?
Feel free to post an issue, but read the FAQ first.
*Note that all licence references and agreements mentioned in the jsduck README section above
are relevant to that project's source code only.