YUIDoc

Fork

This repository is forked from YUIDoc and enhances it to puts the add-on code. Add-on example is set to yuidoc-codeya/addon and themes/addon-example directory. If you try example code, write @id or @note comment to your js file and run command below.

% yuidoc --addondir /path-to-yuidocjs-codeya/addons --theme addon-example js-file-dir -o

You can extend YUIDoc functionality to write your own addon and theme, and run like this.

% yoidoc --addondir your-addon-dir --themedir your-theme-dir js-file-dir

YUI's JavaScript Documentation engine.

Overview

YUIDoc is a Node.js application used at build time to generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a set of HTML pages including information about methods, properties, custom events and inheritance for JavaScript objects.

YUIDoc was originally written for the YUI Project; it uses YUI JavaScript and CSS in the generated files and it supports common YUI conventions like Custom Events. That said, it can be used easily and productively on non-YUI code.

Installation

npm install -g yuidocjs

Documentation

• User Guides
• Change Logs
• API Docs
• Mailing List

Contributing

Please see the CONTRIBUTING.md.

License

This software is free to use under the Yahoo Inc. BSD license. See the LICENSE file for license text and copyright information.