# grunt-doxer

> dox grunt plugin

Latest version **0.2.0** (published 2014-06-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install grunt-doxer
pnpm add grunt-doxer
yarn add grunt-doxer
bun add grunt-doxer
```

Provides the command `grunt-doxer`.

## 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.2.0 |
| Published | 2014-06-13 |
| First published | 2014-06-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | kates |
| Maintainers | harscoet |
| Keywords | gruntplugin |

## Links

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

## Dependencies (4)

- [dox](https://npm.io/package/dox.md) >= 0.0.1
- [grunt](https://npm.io/package/grunt.md) ~0.3.15
- [rimraf](https://npm.io/package/rimraf.md) >= 0.0.1
- [github-flavored-markdown](https://npm.io/package/github-flavored-markdown.md) *

## Recent versions

- 0.2.0 (latest) — 2014-06-13

## README

# grunt-doxer

dox grunt plugin

## Getting Started
Install this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-doxer`

Then add this line to your project's `grunt.js` gruntfile:

```javascript
grunt.loadNpmTasks('grunt-doxer');
```

Update your [grunt.js gruntfile][getting_started]

```javascript
grunt.initConfig({
	...
	doxer: {
		all: {
			src: ["src/lib/**/*.js"],
			dest: "docs",
			options: {
				format: "html", // or "json" or "md" defaults to html
				title: "Doxer API" // defaults to API
			}
		}
	}
	...
})
```

To generate the API docs, run:

```bash
grunt doxer
```

API docs are in docs directory.

[grunt]: https://github.com/cowboy/grunt
[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.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][grunt].


## License
Copyright (c) 2012 kates  
Licensed under the MIT license.

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