http://yui.github.io/yuidoc/

YUI Javascript Documentation Tool
http://yui.github.io/yuidoc/

Last synced: about 1 month ago
JSON representation

YUI Javascript Documentation Tool

• Host: GitHub
• URL: http://yui.github.io/yuidoc/
• Owner: yui
• License: other
• Created: 2008-12-05T02:26:02.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2019-11-06T20:37:31.000Z (over 4 years ago)
• Last Synced: 2024-04-27T00:03:27.165Z (about 1 month ago)
• Language: HTML
• Homepage: http://yui.github.com/yuidoc
• Size: 4.65 MB
• Stars: 892
• Watchers: 42
• Forks: 211
• Open Issues: 131
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-javascript - YUIDoc
• awesome-javascript-cn - YUIDoc
• awesome-javascript - YUIDoc
• awesome-javascript-libraries - YUIDoc
• awesome-javascript - YUIDoc
• awesome-javascript - YUIDoc
• awesome-javascript-builds-project - YUIDoc
• A-collection-of-awesome-browser-side-JavaScript-libraries-resources-and-shiny-things. - YUIDoc
• awesome-javascript - YUIDoc

README

        
YUIDoc

======

YUI's JavaScript Documentation engine.

[![npm Version](https://img.shields.io/npm/v/yuidocjs.svg?style=flat-square)](https://www.npmjs.org/package/yuidocjs)

[![Build Status](http://img.shields.io/travis/yui/yuidoc.svg?style=flat-square)](https://travis-ci.org/yui/yuidoc)

[![Dependency Status](https://img.shields.io/david/yui/yuidoc.svg?style=flat-square)](https://david-dm.org/yui/yuidoc)

Overview

--------

YUIDoc is a [Node.js](http://nodejs.org/) 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](http://yui.github.io/yuidoc/)

* [Change Logs](https://github.com/yui/yuidoc/releases)

* [API Docs](http://yui.github.io/yuidoc/api/)

* [Mailing List](https://groups.google.com/forum/#!forum/yuidoc)

Contributing

------------

Please see the [CONTRIBUTING.md](CONTRIBUTING.md).

License

-------

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