# grunt-contrib-yuidoc

> Compile YUIDoc Documentation

Latest version **1.0.0** (published 2016-03-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install grunt-contrib-yuidoc
pnpm add grunt-contrib-yuidoc
yarn add grunt-contrib-yuidoc
bun add grunt-contrib-yuidoc
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-03-04 |
| First published | 2012-09-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 75 |
| Author | Grunt Team |
| Maintainers | tkellen, cowboy, shama, vladikoff, sindresorhus, jmeas |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-contrib-yuidoc
- Repository: https://github.com/gruntjs/grunt-contrib-yuidoc
- Homepage: https://github.com/gruntjs/grunt-contrib-yuidoc#readme
- Issues: https://github.com/gruntjs/grunt-contrib-yuidoc/issues
- npm.io page: https://npm.io/package/grunt-contrib-yuidoc

## Dependencies (1)

- [yuidocjs](https://npm.io/package/yuidocjs.md) ^0.10.0

## Recent versions

- 1.0.0 (latest) — 2016-03-04
- 0.10.0 — 2015-08-24
- 0.9.0 — 2015-07-29
- 0.8.0 — 2015-05-11
- 0.7.0 — 2015-01-21
- 0.6.0 — 2014-12-28
- 0.5.2 — 2014-03-12
- 0.5.1 — 2014-02-24
- 0.5.0 — 2013-09-01
- 0.4.0 — 2013-02-18
- 0.4.0rc7 — 2013-01-23
- 0.3.2 — 2012-10-12
- 0.3.1 — 2012-10-01
- 0.3.0 — 2012-09-24
- 0.2.0 — 2012-09-10
- … 1 more at https://npm.io/package/grunt-contrib-yuidoc/versions

## README

# grunt-contrib-yuidoc v1.0.0 [![Build Status: Linux](https://travis-ci.org/gruntjs/grunt-contrib-yuidoc.svg?branch=master)](https://travis-ci.org/gruntjs/grunt-contrib-yuidoc) [![Build Status: Windows](https://ci.appveyor.com/api/projects/status/ndcpmex6s8yn9er6/branch/master?svg=true)](https://ci.appveyor.com/project/gruntjs/grunt-contrib-yuidoc/branch/master)

> Compile YUIDoc Documentation



## Getting Started

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-contrib-yuidoc --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-contrib-yuidoc');
```

*This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that [you upgrade](http://gruntjs.com/upgrading-from-0.3-to-0.4), but in case you can't please use [v0.3.2](https://github.com/gruntjs/grunt-contrib-yuidoc/tree/grunt-0.3-stable).*



## Yuidoc task
_Run this task with the `grunt yuidoc` command._

[Visit the YUIDoc project home](http://yui.github.io/yuidoc/) for more information on YUIDocs and commenting syntax.
### Options

Settings mirror [YUIDoc config](http://yui.github.io/yuidoc/args/index.html).
### Usage Examples

```js
grunt.initConfig({
  pkg: grunt.file.readJSON('package.json'),
  yuidoc: {
    compile: {
      name: '<%= pkg.name %>',
      description: '<%= pkg.description %>',
      version: '<%= pkg.version %>',
      url: '<%= pkg.homepage %>',
      options: {
        paths: 'path/to/source/code/',
        themedir: 'path/to/custom/theme/',
        outdir: 'where/to/save/docs/'
      }
    }
  }
});
```


## Release History

 * 2015-08-24   v1.0.0   Bump yuidocjs version to v0.10.0. peerDeps updates. doc updates.
 * 2015-08-24   v0.10.0   Update to yuidocjs ^0.9.0.
 * 2015-06-29   v0.9.0   Update to yuidocjs 0.8.0.
 * 2015-05-11   v0.8.0   Update to yuidocjs 0.7.0.
 * 2015-01-21   v0.7.0   Update to yuidocjs 0.5.0.
 * 2014-12-28   v0.6.0   Update to yuidocjs 0.4.0.
 * 2014-03-12   v0.5.2   Make sure to write JSON data with 'parseOnly'
 * 2014-02-24   v0.5.1   Fixes 'parseOnly' callback
 * 2013-09-01   v0.5.0   Catches and reports errors thrown by YUIDoc with grunt.warn.
 * 2013-02-15   v0.4.0   First official release for Grunt 0.4.0.
 * 2013-01-23   v0.4.0rc7   Updating grunt/gruntplugin dependencies to rc7. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
 * 2013-01-09   v0.4.0rc5   Updating to work with grunt v0.4.0rc5.
 * 2012-10-12   v0.3.2   Rename grunt-contrib-lib dep to grunt-lib-contrib.
 * 2012-10-01   v0.3.1   Project options are parsed as templates.
 * 2012-09-23   v0.3.0   Options no longer accepted from global config key.
 * 2012-09-10   v0.2.0   Refactored from grunt-contrib into individual repo.

---

Task submitted by [George Pantazis](http://georgepantazis.com/)

*This file was generated on Fri Mar 04 2016 17:16:16.*

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