HTTPS clone URL
Subversion checkout URL
- @scss mixin
- A touch of style
- Advanced usage
- Auto detection
- Boolean tags
- Config file
- Custom member types
- Custom tags
- Generating warnings
- HTML output
- Inline examples
- Markdown formatting
- More about parsing
- Multi line tags
- New in jsduck 5
- Overriding built in tags
- Popup menu
- Single line tags
- Standard tags
- Type Definitions
- Welcome page
Clone this wiki locally
The standard way to install on most platforms is to just install the jsduck gem:
$ gem install jsduck
If you encounter errors during gem installation, you may need to install the header files for compiling extension modules for Ruby 1.9. For Debian systems you'll need the
ruby1.9-dev package. For Red Hat / CentOS / Fedora use the
You need a C/C++ compiler in your system to compile some of the JSDuck dependencies. The simplest route is to install the Xcode command line tools from App store (you don't need the full Xcode, just command line tools will suffice). Or you could try installing GCC instead.
The Ruby 1.8 that comes with OS X can work fine, however some users have reported problems with it and have found a solution in upgrading to Ruby 1.9 using RVM.
If you install Ruby 1.9, use this command:
rvm install 1.9.3 --with-gcc=gcc
See Cannot compile ruby 1.9.3 for more information.
For Windows users out there, there are two main options.
- Download the single exe file with everything bundled together (simple).
- Install Ruby and then the JSDuck gem (read forward, but be brave).
To install JSDuck through gem, you first need Ruby.
Grab the latest Ruby installer from rubyinstaller.org. Run it and make sure Ruby executable gets added to your
You also need to install the Development Kit to be able to build native extensions - download it from the same site, then follow the installation instructions (be careful when using the self-extracting exe - if you don't give it a new directory name, it will unpack all files to the current directory, which you probably don't want).
Now you're ready to install JSDuck using the standard gem install:
> gem install jsduck
If this all worked, then go buy yourself a beer, you really deserve it after making through all this hassle.
If the install still didn't succeed don't blame yourself. Go file a bug report and I'll try to help you out.