ember-cli-addon-docs-yuidoc

1.1.0 verified Sat Apr 25 auth: no javascript

A YUIDoc plugin for Ember CLI Addon Docs that provides automatic API documentation generation for Ember addons. Version 1.1.0, released with support for GTS/GJS files, requires Node 10+ and Ember.js 3.16+. It extends standard YUIDoc with support for Ember-specific constructs like components (@argument, @yield), accessors, computed properties, modules, and helpers. Key differentiators include native Ember conventions, automatic module detection, and Markdown in comments. Maintained by the Ember Learning team, with a release cadence of several months.

Common errors

error Missing required peer dependency: ember-cli-addon-docs ↓

cause The package requires ember-cli-addon-docs as a peer dependency which is not automatically installed.

fix

Install the peer dependency with ember install ember-cli-addon-docs.

Warnings

breaking v1.0.0 dropped support for Node < 10 and bumped Ember to 3.22 ↓

fix Upgrade Node to >=10 and Ember to >=3.16.

Install

npm install ember-cli-addon-docs-yuidoc

yarn add ember-cli-addon-docs-yuidoc

pnpm add ember-cli-addon-docs-yuidoc

Imports

ember-cli-addon-docs-yuidoc
wrong
```
npm install ember-cli-addon-docs-yuidoc
```
correct
```
ember install ember-cli-addon-docs-yuidoc
```
Should be installed via ember install to ensure blueprint runs.

Quickstart

Install the addon and follow YUIDoc syntax to document classes, components, and modules.

ember install ember-cli-addon-docs-yuidoc
# Then document your addon as described in the README