Skip to content

yui/yuidoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Mar 6, 2015
5c0ae88 · Mar 6, 2015
Mar 6, 2015
Mar 6, 2015
Mar 4, 2015
Mar 6, 2015
Nov 21, 2014
Feb 18, 2015
Jan 15, 2015
Nov 21, 2014
Nov 24, 2010
Feb 7, 2015
Nov 20, 2014
Sep 13, 2011
Nov 21, 2014
Nov 20, 2014
Mar 6, 2015

Repository files navigation

YUIDoc

YUI's JavaScript Documentation engine.

npm Version Build Status Dependency Status

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

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.