https://github.com/broccolijs/broccoli-yuidoc
YUIDoc generator for broccoli
https://github.com/broccolijs/broccoli-yuidoc
broccoli broccoli-yuidoc javascript yuidoc
Last synced: about 1 month ago
JSON representation
YUIDoc generator for broccoli
- Host: GitHub
- URL: https://github.com/broccolijs/broccoli-yuidoc
- Owner: broccolijs
- License: bsd-2-clause
- Created: 2014-05-16T09:57:27.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T23:16:23.000Z (over 2 years ago)
- Last Synced: 2025-04-14T08:18:16.094Z (about 2 months ago)
- Topics: broccoli, broccoli-yuidoc, javascript, yuidoc
- Language: JavaScript
- Size: 118 KB
- Stars: 6
- Watchers: 2
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# broccoli-yuidoc [](https://travis-ci.org/broccolijs/broccoli-yuidoc) [](https://ci.appveyor.com/project/embercli/broccoli-yuidoc)
This plugin provides support for generating YUIDoc via a broccoli
pipeline.
## Installation
```
npm 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](https://yui.github.io/yuidoc/args/index.html).
Note: If a `yuidoc.json` file exists in a parent directory, it will be
used as well.
## Usage
```js
var YUIDoc = require('broccoli-yuidoc');
var mergeTrees = require('broccoli-merge-trees');
// As with most other broccoli plugins, you can
// define the base directory of the files you
// would like documentation generated for as
// the first paramter, and specify source and
// destination directories.
// Custom YUIdoc options is passed as yuidoc.
var yuidocTree = new YUIDoc(['app'], {
destDir: 'docs',
yuidoc: {
// .. yuidoc option overrides
}
});
// To merge the YUIdoc build tree with, let's say,
// an ember application tree, use broccoli-mergetrees
var applicationTree = mergeTrees([app.toTree(), yuidocTree]);
module.exports = applicationTree;
```
It's recomended to use `broccoli-merge-trees` to finally produce
a signle tree for broccoli to work on.