| 1 | JSDoc 3
|
| 2 | =======
|
| 3 | [](http://travis-ci.org/jsdoc3/jsdoc)
|
| 4 |
|
| 5 | An API documentation generator for JavaScript.
|
| 6 |
|
| 7 | Want to contribute to JSDoc? Please read `CONTRIBUTING.md`.
|
| 8 |
|
| 9 | Installation and Usage
|
| 10 | ----------------------
|
| 11 |
|
| 12 | JSDoc supports Node.js 0.10 and later. You can install JSDoc in your project's
|
| 13 | `node_modules` folder, or you can install it globally.
|
| 14 |
|
| 15 | To install the latest version available on NPM:
|
| 16 |
|
| 17 | npm install jsdoc
|
| 18 |
|
| 19 | To install the latest development version:
|
| 20 |
|
| 21 | npm install git+https://github.com/jsdoc3/jsdoc.git
|
| 22 |
|
| 23 | If you installed JSDoc locally, the JSDoc command-line tool is available in
|
| 24 | `./node_modules/.bin`. To generate documentation for the file
|
| 25 | `yourJavaScriptFile.js`:
|
| 26 |
|
| 27 | ./node_modules/.bin/jsdoc yourJavaScriptFile.js
|
| 28 |
|
| 29 | Or if you installed JSDoc globally, simply run the `jsdoc` command:
|
| 30 |
|
| 31 | jsdoc yourJavaScriptFile.js
|
| 32 |
|
| 33 | By default, the generated documentation is saved in a directory named `out`. You
|
| 34 | can use the `--destination` (`-d`) option to specify another directory.
|
| 35 |
|
| 36 | Run `jsdoc --help` for a complete list of command-line options.
|
| 37 |
|
| 38 | Templates and Build Tools
|
| 39 | -------------------------
|
| 40 |
|
| 41 | The JSDoc community has created numerous templates and other tools to help you
|
| 42 | generate and customize your documentation. Here are just a few:
|
| 43 |
|
| 44 | ### Templates
|
| 45 |
|
| 46 | + [jaguarjs-jsdoc](https://github.com/davidshimjs/jaguarjs-jsdoc)
|
| 47 | ([example](http://davidshimjs.github.io/jaguarjs/doc))
|
| 48 | + [DocStrap](https://github.com/docstrap/docstrap) ([example](https://docstrap.github.io/docstrap))
|
| 49 | + [jsdoc3Template](https://github.com/DBCDK/jsdoc3Template)
|
| 50 | ([example](https://github.com/danyg/jsdoc3Template/wiki#wiki-screenshots))
|
| 51 | + [minami](https://github.com/Nijikokun/minami)
|
| 52 | + [docdash](https://github.com/clenemt/docdash)([example](http://clenemt.github.io/docdash/))
|
| 53 |
|
| 54 | ### Build Tools
|
| 55 |
|
| 56 | + [JSDoc Grunt plugin](https://github.com/krampstudio/grunt-jsdoc)
|
| 57 | + [JSDoc ant task](https://github.com/jannon/jsdoc3-ant-task)
|
| 58 |
|
| 59 |
|
| 60 | For More Information
|
| 61 | --------------------
|
| 62 |
|
| 63 | + Documentation is available at [Use JSDoc](http://usejsdoc.org).
|
| 64 | + Contribute to the docs at [jsdoc3/jsdoc3.github.com](https://github.com/jsdoc3/jsdoc3.github.com).
|
| 65 | + Ask for help on the [JSDoc Users mailing list](http://groups.google.com/group/jsdoc-users).
|
| 66 | + Post questions tagged `jsdoc` to [Stack
|
| 67 | Overflow](http://stackoverflow.com/questions/tagged/jsdoc).
|
| 68 |
|
| 69 | License
|
| 70 | -------
|
| 71 |
|
| 72 | JSDoc 3 is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the
|
| 73 | [contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
|
| 74 |
|
| 75 | JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See
|
| 76 | the file `LICENSE.md` in this distribution for more details.
|