Registry / web-framework / ember-cli-addon-docs-yuidoc

ember-cli-addon-docs-yuidoc

JSON →
library1.1.0jsnpmunverified

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.

npm install ember-cli-addon-docs-yuidoc
INSTALL
IMPORT
SIG · EMBER-CLI-ADDON-DO
E
ember-cli-addon-docs-yuidoc
web-frameworkjavascriptv1.1.0
Install
—
Import
—
Disk
—
Pass rate
0/ 6
Env Coverage0 / 6
glibc
18–22
musl
18–22
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18–226 runs
build_error
glibc
node 18–226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

ember-cli-addon-docs-yuidoc
✓ ember install ember-cli-addon-docs-yuidoc
✗ npm install ember-cli-addon-docs-yuidoc
Should be installed via ember install to ensure blueprint runs.

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
Debug
Known issues
breakingv1.0.0 dropped support for Node < 10 and bumped Ember to 3.22
fix
Upgrade Node to >=10 and Ember to >=3.16.
affects: 1.0.0 and above
Errors
Common errors & fixes
Missing required peer dependency: ember-cli-addon-docs
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`.
Upgrade
Version history
1.1.0latest on npm
Audit
Dependencies
ember-cli-addon-docsrequiredRequired as a peer dependency for the plugin to function
Agent activity
6 hits · last 30 days
node
4
OpenAI (training)
2
Resources
ember-cli-addon-docs-yuidoc — npm install ember-cli-addon-docs-yuidoc · libregistry