# gulp-apidoc

> RESTful web API Documentation Generator

Latest version **0.2.8** (published 2018-06-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-apidoc
pnpm add gulp-apidoc
yarn add gulp-apidoc
bun add gulp-apidoc
```

## 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.8 |
| Published | 2018-06-06 |
| First published | 2014-02-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 61 |
| Author | Ayhan Kuru |
| Maintainers | cobaimelan |
| Keywords | gulpplugin, apidoc, documentation, rest, doc |

## Links

- npm: https://www.npmjs.com/package/gulp-apidoc
- Repository: https://github.com/c0b41/gulp-apidoc
- Issues: https://github.com/c0b41/gulp-apidoc/issues
- npm.io page: https://npm.io/package/gulp-apidoc

## Dependencies (5)

- [apidoc](https://npm.io/package/apidoc.md) *
- [fancy-log](https://npm.io/package/fancy-log.md) ^1.3.2
- [ansi-colors](https://npm.io/package/ansi-colors.md) ^1.1.0
- [plugin-error](https://npm.io/package/plugin-error.md) ^1.0.1
- [object-assign](https://npm.io/package/object-assign.md) ^4.1.1

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.2.8 (latest) — 2018-06-06
- 0.2.7 — 2018-02-22
- 0.2.6 — 2017-04-03
- 0.2.5 — 2017-01-17
- 0.2.4 — 2016-05-15
- 0.2.3 — 2016-02-18
- 0.2.2 — 2015-12-16
- 0.2.0 — 2015-09-29
- 0.1.5 — 2015-07-17
- 0.1.4 — 2015-05-17
- 0.1.3 — 2015-05-05
- 0.1.2 — 2015-01-05
- 0.1.1 — 2014-12-30
- 0.0.3 — 2014-08-14
- 0.0.1 — 2014-02-21

## README

# [gulp](https://github.com/gulpjs/gulp)-apidoc 


![npm-version](https://img.shields.io/npm/v/gulp-apidoc.svg)
![download-count](https://img.shields.io/npm/dm/gulp-apidoc.svg)
![dev-deps](https://david-dm.org/c0b41/gulp-apidoc.svg)


Generates a RESTful web API Documentationusing the [apidoc](https://github.com/apidoc/apidoc) library.

## How It Works
`/path/api/stuff.js`:
```js
/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */
```


## Install

Install with [npm](https://npmjs.org/package/gulp-apidoc)

```
npm install --save-dev gulp-apidoc
```


## Usage

```js
var gulp = require('gulp'),
    apidoc = require('gulp-apidoc');

gulp.task('apidoc', function(done){
          apidoc({
            src: "example/",
            dest: "build/"
          },done);
});
```

With options:

```js
var gulp = require('gulp'),
    apidoc = require('gulp-apidoc');

gulp.task('apidoc',function(done){
              apidoc({
	              src: "example/",
                  dest: "build/",
                  template: "template/",
                  debug: true,
                  includeFilters: [ ".*\\.js$" ]
              },done);
});
```

Other options [checkout](https://github.com/apidoc/apidoc/blob/master/lib/index.js#L14-L21).


## Options


#### options.src

The folder to scan for apidoc documentation.

Type: `String`


#### options.dest

The folder where to output the generated files.

Type: `String`
Default: `doc/`

#### options.template

Custom template to use for the output files.

Type: `String`

#### options.config

Type: `String`
Default: `options.src`

#### options.debug

Type: `Boolean`
Default: `false`

#### options.silent

Type: `Boolean`
Default: `false`

#### options.verbose

Type: `Boolean`
Default: `false`

#### options.simulate

Type: `Boolean`
Default: `false`

#### options.includeFilters

Type: `Array`
Default: `[]`

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