Popularity
4.1
Growing
Activity
0.0
Stable
1,504
94
250

Code Quality Rank: L4
Monthly Downloads: 9,516
Programming language: Ruby
License: GNU General Public License v3.0 only
Tags: Documentation    
Latest version: v6.0.0.beta

jsduck alternatives and similar libraries

Based on the "Documentation" category

  • sphinx

    a tool that makes it easy to create intelligent and beautiful documentation
  • documentation.js

    API documentation generator with support for ES2015+ and flow annotation.
  • Beautiful docs

    is a documentation viewer based on markdown files.
  • docco

    is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.
  • ESDoc

    is a good documentation generator for JavaScript.
  • dox

    4.4 1.6 L4 jsduck VS dox
    is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply gives you a JSON representation, allowing you to use markdown and JSDoc-style tags.
  • codecrumbs

    is a visual tool for learning and documenting a codebase by putting breadcrumbs in source code.
  • styledocco

    generates documentation and style guide documents from your stylesheets.
  • YUIDoc

    is a Node.js application that generates API documentation from comments in source, using a syntax similar to tools like Javadoc and Doxygen.
  • Ronn

    3.2 0.0 L5 jsduck VS Ronn
    builds manuals. It converts simple, human readable textfiles to roff for terminal display, and also to HTML for the web.
  • dexy

    2.2 5.7 L4 jsduck VS dexy
    is a free-form literate documentation tool for writing any kind of technical document incorporating code.
  • jsdox

    is a JSDoc3 to Markdown documentation generator.
  • ip-num

    A TypeScript library for working with ASN, IPv4, and IPv6 numbers.
  • 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.

Do you think we are missing an alternative of jsduck or a related project?

Add another 'Documentation' Library

README

JSDuck

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.

Build Status

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?

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.