# grunt-package-documenter

> Generates Markdown documentation of all installed npm modules (and bower components if any) used by your project.

Latest version **0.1.2** (published 2015-12-04) · 0 weekly downloads

## Install

```sh
npm install grunt-package-documenter
pnpm add grunt-package-documenter
yarn add grunt-package-documenter
bun add grunt-package-documenter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2015-12-04 |
| First published | 2015-12-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.2.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Adam Liechty |
| Maintainers | adamliechty |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-package-documenter
- Repository: https://github.com/adamliechty/grunt-package-documenter
- Issues: https://github.com/adamliechty/grunt-package-documenter/issues
- npm.io page: https://npm.io/package/grunt-package-documenter

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^3.10.1

## Recent versions

- 0.1.2 (latest) — 2015-12-04
- 0.1.1 — 2015-12-03
- 0.1.0 — 2015-12-03

## README

# grunt-package-documenter

[![bitHound Overalll Score](https://www.bithound.io/github/AdamLiechty/grunt-package-documenter/badges/score.svg)](https://www.bithound.io/github/AdamLiechty/grunt-package-documenter)


> Generates Markdown documentation of all installed npm modules (and bower components if any) used by your project.

## Sample output
```markdown
# 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
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-package-documenter --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-package-documenter');
```

## The "package_documenter" task

### Overview
In your project's Gruntfile, add a section named `package_documenter` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  package_documenter: {
    options: {
      output: './doc/third-party.md'
    }
  },
});
```

### Options

#### options.output
Type: `String`
Default value: `'./doc/third-party.md'`

The location to write the documentation.
ing else with whatever else.

### Usage Examples

#### Default Options
```js
grunt.initConfig({
  package_documenter: {
    options: {
      output: './doc/third-party.md'
    }
  },
});
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

---
_Source: https://npm.io/package/grunt-package-documenter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._