archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

improve installation instructions and reformat

Browse Source
This commit is contained in:
Jeff Williams 2017-07-12 16:17:46 -07:00
parent 11e8c6d5e2
commit ec7ac85ecb
1 changed files with 27 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -9,20 +9,31 @@ Want to contribute to JSDoc? Please read `CONTRIBUTING.md`.
Installation and Usage
----------------------
JSDoc supports Node.js 4.2.0 and later. You can install JSDoc in your project's
`node_modules` folder, or you can install it globally.
JSDoc supports Node.js 4.2.0 and later. You can install JSDoc globally or in your project's
`node_modules` folder.
To install the latest version available on NPM:
To install the latest version on npm globally (may require `sudo`; [learn how to fix
this](https://docs.npmjs.com/getting-started/fixing-npm-permissions)):
npm install jsdoc
npm install -g jsdoc
To install the latest development version:
To install the latest version on npm locally and save it in your package's `package.json` file:
npm install --save-dev jsdoc
**Note**: By default, npm adds your package using the caret operator in front of the version number
(for example, `^3.5.2`). We recommend using the tilde operator instead (for example, `~3.5.2`),
which limits updates to the most recent patch-level version. See [this Stack Overflow
answer](https://stackoverflow.com/questions/22343224) for more information about the caret and tilde
operators.
To install the latest development version locally, without updating your project's `package.json`
file:
npm install git+https://github.com/jsdoc3/jsdoc.git
If you installed JSDoc locally, the JSDoc command-line tool is available in
`./node_modules/.bin`. To generate documentation for the file
`yourJavaScriptFile.js`:
If you installed JSDoc locally, the JSDoc command-line tool is available in `./node_modules/.bin`.
To generate documentation for the file `yourJavaScriptFile.js`:
./node_modules/.bin/jsdoc yourJavaScriptFile.js
@ -30,16 +41,16 @@ Or if you installed JSDoc globally, simply run the `jsdoc` command:
jsdoc yourJavaScriptFile.js
By default, the generated documentation is saved in a directory named `out`. You
can use the `--destination` (`-d`) option to specify another directory.
By default, the generated documentation is saved in a directory named `out`. You can use the
`--destination` (`-d`) option to specify another directory.
Run `jsdoc --help` for a complete list of command-line options.
Templates and Build Tools
-------------------------
The JSDoc community has created numerous templates and other tools to help you
generate and customize your documentation. Here are just a few:
The JSDoc community has created numerous templates and other tools to help you generate and
customize your documentation. Here are just a few:
### Templates
@ -68,8 +79,8 @@ Overflow](http://stackoverflow.com/questions/tagged/jsdoc).
License
-------
JSDoc 3 is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the
[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
JSDoc 3 is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the [contributors to
JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See
the file `LICENSE.md` in this distribution for more details.
JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file `LICENSE.md`
in this distribution for more details.