# gulp-doxx

> Doxx documentation generator for gulp

Latest version **0.0.5** (published 2015-08-20) · MIT license · 0 weekly downloads

## Install

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

## 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.0.5 |
| Published | 2015-08-20 |
| First published | 2014-09-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+9 in 2 direct dependencies) |
| Install scripts | no |
| Author | filipovsky |
| Maintainers | filipovsky |
| Keywords | gulp, doxx, dox, documentation |

## Links

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

## Dependencies (8)

- [dox](https://npm.io/package/dox.md) ^0.8.0
- [doxx](https://npm.io/package/doxx.md) ^1.5.0
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [vinyl](https://npm.io/package/vinyl.md) ^0.5.1
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [marked](https://npm.io/package/marked.md) ^0.3.5
- [through2](https://npm.io/package/through2.md) ^2.0.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.6

## 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.0.5 (latest) — 2015-08-20
- 0.0.4 — 2015-01-11
- 0.0.3 — 2014-12-10
- 0.0.2 — 2014-09-20
- 0.0.1 — 2014-09-20

## README

# gulp-doxx

[Doxx][doxx] documentation generator for [gulp][gulp].

## Install

    npm install gulp-doxx

## Configure

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

gulp.task('docs', function() {

  gulp.src(['**/*.js', 'README.md'], {base: '.'})
    .pipe(gulpDoxx({
      title: 'My App Title',
      urlPrefix: '/docs'
    }))
    .pipe(gulp.dest('docs'));

});
```



## Options

### title
Type: `String`

The title of your project

Default: `Title not set`

### urlPrefix
Type: `String`

Default: `null`

Prefix to be used for generating links in menu.

#### Examples

**Without** `urlPrefix` menu link could look like:

```html
<a href="script.js.html">script.js</a>
```

Same link with `urlPrefix` set to `./docs`:

```html
<a href="./docs/script.js.html">script.js</a>
```

Same link with `urlPrefix` set to `http://my-docs-server.io`:

```html
<a href="http://my-docs-server.io/script.js.html">script.js</a>
```


### template

Type: `String`

Default: `undefined`

Path to jade template to be used to generate result.

If not set, default [doxx template][doxx-example] will be used.

## Run

    gulp docs

[doxx]: https://github.com/FGRibreau/doxx
[gulp]: http://gulpjs.com/
[doxx-example]: http://fgribreau.github.io/doxx/docs/compile.js.html

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