0.1.5 • Published 8 years ago

package-documenter v0.1.5

Weekly downloads
2
License
MIT
Repository
github
Last release
8 years ago

grunt-package-documenter

bitHound Overalll Score

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

  1. Install the package

    npm install package-documenter --save-dev
  2. 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

0.1.5

8 years ago

0.1.4

8 years ago

0.1.3

8 years ago

0.1.2

8 years ago