# yuidoc

**Repository Path**: mirrors_Shopify/yuidoc

## Basic Information

- **Project Name**: yuidoc
- **Description**: YUI Javascript Documentation Tool
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-28
- **Last Updated**: 2026-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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.