Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gruntjs/grunt-contrib-yuidoc
Compile YUIDoc Documentation.
https://github.com/gruntjs/grunt-contrib-yuidoc
Last synced: about 8 hours ago
JSON representation
Compile YUIDoc Documentation.
- Host: GitHub
- URL: https://github.com/gruntjs/grunt-contrib-yuidoc
- Owner: gruntjs
- License: mit
- Created: 2012-09-07T20:52:35.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2021-03-22T15:01:33.000Z (almost 4 years ago)
- Last Synced: 2025-01-01T21:09:54.288Z (7 days ago)
- Language: JavaScript
- Homepage: http://gruntjs.com/
- Size: 74.2 KB
- Stars: 75
- Watchers: 9
- Forks: 23
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-contrib-yuidoc v1.0.0 [](https://travis-ci.org/gruntjs/grunt-contrib-yuidoc) [](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 18 2016 19:12:25.*