# grunt-doxx

> Generate your docs with Doxx.

Latest version **0.1.3** (published 2015-11-13) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2015-11-13 |
| First published | 2014-06-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Evertton de Lima |
| Maintainers | evertton |
| Keywords | gruntplugin, dox, documentation, docs, documentor |

## Links

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

## Dependencies (2)

- [doxx](https://npm.io/package/doxx.md) *
- [rimraf](https://npm.io/package/rimraf.md) 2.x

## 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.1.3 (latest) — 2015-11-13
- 0.1.2 — 2014-10-31
- 0.1.1 — 2014-07-04
- 0.1.0 — 2014-06-04

## README

# grunt-doxx

Doxx grunt plugin automatically generates the documentation for your project.

## 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-doxx --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-doxx');
```

## The "doxx" task

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

```js
grunt.initConfig({
  doxx: {
    all: {
      src: 'src',
      target: 'docs',
      options: {
        // Task-specific options go here.
      }
    }
  },
});
```

### Options

#### options.ignore
Type: `String`
Default value: `'test,public,static,views,templates'`

A comma separated list of directories to ignore.

#### options.title
Type: `String`
Default value: `''`

The title for produced page.

#### options.target_extension
Type: `String`
Default value: `'html'`

Target files extension.

#### options.template
Type: `String`
Default value: ` `

The jade template file to use.

#### options.theme
Type: `String`
Default value: ` `

The theme to use.

#### options.readme
Type: `String`
Default value: `'README.md'`

The markdown file to use on the main page of the documentations.

### Usage Examples

#### Default Options
In this example, the default options are used to automatically generates documentation of files in `src` directory. The generated documentation is saved in target directory `docs`.

```js
grunt.initConfig({
  doxx: {
    all: {
      src: 'src',
      target: 'docs'
    }
  },
});
```

#### Custom Options
In this example, the custom options are used to change *title* and *template* of documentation page. The *ignore* option is used to prevent the documents generation for files in the directories: `examples` and `vendors`.

```js
grunt.initConfig({
  doxx: {
    custom: {
      src: 'src',
      target: 'docs',
      options: {
        title: 'Doxx',
        ignore: 'examples,vendors',
        template: 'templates/doxx.jade'
      },
    }
  },
});
```

## 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
* **0.1.3**: Adds support for theme
* **0.1.0**: Initial release

## License
Copyright (c) 2014-2015 Evertton de Lima. Licensed under the [MIT 
license](http://evertton.mit-license.org).

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