Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 45 lines (31 sloc) 1.577 kB
94b221f @okuryu Revamp README
okuryu authored
1 YUIDoc
2 ======
1d8cd71 @dtan adding in documentation from the python build
dtan authored
3
94b221f @okuryu Revamp README
okuryu authored
4 YUI's JavaScript Documentation engine.
071e2ad @davglass README update
davglass authored
5
94b221f @okuryu Revamp README
okuryu authored
6 [![npm Version](https://img.shields.io/npm/v/yuidocjs.svg?style=flat-square)](https://www.npmjs.org/package/yuidocjs)
7 [![Build Status](http://img.shields.io/travis/yui/yuidoc.svg?style=flat-square)](https://travis-ci.org/yui/yuidoc)
8 [![Dependency Status](https://img.shields.io/david/yui/yuidoc.svg?style=flat-square)](https://david-dm.org/yui/yuidoc)
6766dd8 @davglass Added Build Status
davglass authored
9
94b221f @okuryu Revamp README
okuryu authored
10 Overview
11 --------
12
13 YUIDoc is a [Node.js](http://nodejs.org/) application used at build time to
14 generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide
15 range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a
16 set of HTML pages including information about methods, properties, custom events and
17 inheritance for JavaScript objects.
18
19 YUIDoc was originally written for the YUI Project; it uses YUI JavaScript and CSS in the
20 generated files and it supports common YUI conventions like Custom Events. That said,
21 it can be used easily and productively on non-YUI code.
6766dd8 @davglass Added Build Status
davglass authored
22
4087db1 @davglass README update
davglass authored
23 Installation
24 ------------
8fc21db @dtan trying to fix formatting
dtan authored
25
94b221f @okuryu Revamp README
okuryu authored
26 npm install -g yuidocjs
8fc21db @dtan trying to fix formatting
dtan authored
27
4087db1 @davglass README update
davglass authored
28 Documentation
29 -------------
1d8cd71 @dtan adding in documentation from the python build
dtan authored
30
94b221f @okuryu Revamp README
okuryu authored
31 * [User Guides](http://yui.github.io/yuidoc/)
32 * [Change Logs](https://github.com/yui/yuidoc/releases)
33 * [API Docs](http://yui.github.io/yuidoc/api/)
34 * [Mailing List](https://groups.google.com/forum/#!forum/yuidoc)
35
df2c592 @okuryu Move from DEVELOPMENT.md to CONTRIBUTING.md
okuryu authored
36 Contributing
37 ------------
38
39 Please see the [CONTRIBUTING.md](CONTRIBUTING.md).
40
94b221f @okuryu Revamp README
okuryu authored
41 License
42 -------
43
44 This software is free to use under the Yahoo Inc. BSD license. See the [LICENSE file](LICENSE) for license text and copyright information.
Something went wrong with that request. Please try again.