Skip to content
YUI Javascript Documentation Tool
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
conf/docs fix all yui to yui-s Apr 16, 2017
docs Build documentations Jan 18, 2016
lib fix all yui to yui-s Apr 16, 2017
output fix all yui to yui-s Apr 16, 2017
scripts Remove unused tests Nov 21, 2014
tests Added extension_for tag tests to builder test suite Jun 21, 2016
themes fix all yui to yui-s Apr 16, 2017
.eslintrc
.gitignore Remove unused tests Nov 21, 2014
.npmignore Update .npmignore Aug 18, 2016
.travis.yml CI building updates Feb 27, 2017
CONTRIBUTING.md
LICENSE Licensing updates Sep 13, 2011
Makefile Remove unused tests Nov 21, 2014
README.md Move from DEVELOPMENT.md to CONTRIBUTING.md Nov 20, 2014
package.json allow ssl Apr 13, 2017
yui.yahooapis.co fix all yui to yui-s Apr 16, 2017

README.md

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.

You can’t perform that action at this time.