# yuidocjs

> YUIDoc, YUI's JavaScript Documentation engine.

Latest version **0.10.2** (published 2016-07-11) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install yuidocjs
pnpm add yuidocjs
yarn add yuidocjs
bun add yuidocjs
```

Provides the command `yuidoc`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.2 |
| Published | 2016-07-11 |
| First published | 2012-01-10 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Author | Dav Glass |
| Maintainers | andrewnicols, caridy, davglass, ericf, okuryu, stefanpenner |
| Keywords | yui, jsdoc, coffeescript, api, documentation, javadoc, docs, apidocs |

## Links

- npm: https://www.npmjs.com/package/yuidocjs
- Repository: https://github.com/yui/yuidoc
- Homepage: https://github.com/yui/yuidoc#readme
- Issues: http://github.com/yui/yuidoc/issues
- npm.io page: https://npm.io/package/yuidocjs

## Dependencies (7)

- [yui](https://npm.io/package/yui.md) ^3.18.1
- [rimraf](https://npm.io/package/rimraf.md) ^2.4.1
- [express](https://npm.io/package/express.md) ^4.13.1
- [mdn-links](https://npm.io/package/mdn-links.md) ^0.1.0
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.2
- [graceful-fs](https://npm.io/package/graceful-fs.md) ^4.1.2
- [markdown-it](https://npm.io/package/markdown-it.md) ^4.3.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.10.2 (latest) — 2016-07-11
- 0.3.0 (official) — 2012-05-09
- 0.10.1 — 2016-04-25
- 0.10.0 — 2016-01-18
- 0.9.0 — 2015-08-19
- 0.8.1 — 2015-07-30
- 0.8.0 — 2015-07-24
- 0.7.0 — 2015-04-29
- 0.6.0 — 2015-03-06
- 0.5.0 — 2015-01-20
- 0.4.0 — 2014-11-18
- 0.3.50 — 2014-04-22
- 0.3.49 — 2014-03-08
- 0.3.48 — 2014-02-19
- 0.3.47 — 2014-01-13
- … 85 more at https://npm.io/package/yuidocjs/versions

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

---
_Source: https://npm.io/package/yuidocjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._