simplabs/broccoli-yuidoc

Name: broccoli-yuidoc

Owner: simplabs

Description: YUIDoc generator for broccoli

Created: 2015-09-07 18:50:46.0

Updated: 2017-05-10 21:21:25.0

Pushed: 2015-09-23 20:50:32.0

Homepage: null

Size: 105

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

broccoli-yuidoc

This plugin provides support for generating YUIDoc via a broccoli pipeline.

Installation

install --save-dev broccoli-yuidoc

Configuration

Additional options related to YUIDoc may be may be passed as an object yuidoc to yuidocCompiler. All of the available options can be found on YUIDoc's official documentation page.

Note: If a yuidoc.json file exists in a parent directory, it will be used as well.

Usage

yuidocCompiler = require('broccoli-yuidoc');
mergeTrees = require('broccoli-merge-trees');

s with most other broccoli plugins, you can
efine the base directory of the files you
ould like documentation generated for as 
he first paramter, and specify source and
estination directories.
ustom YUIdoc options is passed as yuidoc.
yuidocTree = yuidocCompiler('app', {
srcDir: '/',
destDir: 'docs',
yuidoc: {
    // .. yuidoc option overrides
}



o merge the YUIdoc build tree with, let's say,
n ember application tree, use broccoli-mergetrees 
applicationTree = mergeTrees([app.toTree(), yuidocTree]);

le.exports = applicationTree;

It's recomended to use broccoli-merge-trees to finally produce a signle tree for broccoli to work on.