package-documenter
v0.1.5
Published
Generates Markdown documentation of all installed npm modules (and bower components if any) used by your project.
Downloads
5
Readme
grunt-package-documenter
Generates Markdown documentation of all installed npm modules (and bower components if any) used by your project.
Sample output
# my-app
## Direct Dependencies
### Node
[lodash](#lodash)
## NodeJS modules
### lodash
version 3.10.1 (MIT license)
The modern build of lodash modular utilities.
[Homepage](https://lodash.com/)
#### Dependers
[my-app](#my-app)
Getting Started
- Install the package
npm install package-documenter --save-dev
- Run it
From your project root:
require('package-documenter')('doc/third_party.md')
This will generate the documentation in a file located at doc/thirdparty.md