Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://yui.github.io/yuidoc/
YUI Javascript Documentation Tool
https://yui.github.io/yuidoc/
Last synced: about 2 months ago
JSON representation
YUI Javascript Documentation Tool
- Host: GitHub
- URL: https://yui.github.io/yuidoc/
- Owner: yui
- License: other
- Created: 2008-12-05T02:26:02.000Z (almost 16 years ago)
- Default Branch: master
- Last Pushed: 2019-11-06T20:37:31.000Z (almost 5 years ago)
- Last Synced: 2024-05-22T05:02:56.787Z (4 months 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
Awesome Lists containing this project
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.