Ember CLI YUIDoc Theme

1.0.4 verified Thu Apr 23 auth: no javascript abandoned

YUIDoc is a Node.js-based documentation generator that creates API documentation from Javadoc-style comments in source code. While not specific to JavaScript, it was designed for the YUI Library. This package, `yuidoc-ember-cli-theme`, provides a visual theme specifically styled for Ember CLI projects when using YUIDoc for documentation. It customizes the output HTML by directing `themedir` and `helpers` within the `yuidoc.json` configuration. The package is currently at version 1.0.4. Given that YUIDoc itself saw its last major update (0.10.0) in 2016 and the Ember community has largely transitioned to more modern documentation solutions like `ember-cli-addon-docs` (which offers more robust support for contemporary JavaScript features and Ember specifics, even if it can use a modified YUIDoc internally), this theme is no longer actively maintained. Its key differentiator was providing an Ember-specific look for YUIDoc output at a time when YUIDoc was more prevalent.

Common errors

error Error: Cannot find module 'yuidocjs' ↓

cause `yuidocjs` (the YUIDoc generator) is not installed globally or locally.

fix

Run npm install -g yuidocjs to install it globally, or npm install --save-dev yuidocjs in your project.

error YUIDoc: themedir is not a directory or does not contain a theme ↓

cause The `themedir` path in `yuidoc.json` is incorrect or the `yuidoc-ember-cli-theme` package is not correctly installed in `node_modules`.

fix

Verify that node_modules/yuidoc-ember-cli-theme exists and contains the theme files. Ensure the path in yuidoc.json is exactly node_modules/yuidoc-ember-cli-theme relative to your project root.

error Error: ENOENT: no such file or directory, stat 'node_modules/yuidoc-ember-cli-theme/helpers.js' ↓

cause The `helpers` file path in `yuidoc.json` is incorrect, or the file is missing from the installed package.

fix

Ensure the path node_modules/yuidoc-ember-cli-theme/helpers.js is correct and the file exists within the installed package. Re-install the package if necessary: npm uninstall yuidoc-ember-cli-theme && npm install yuidoc-ember-cli-theme.

Warnings

breaking YUIDoc (the underlying documentation tool) is an older project, with its last major release in 2016. It may have compatibility issues with newer Node.js versions or modern JavaScript syntax features (e.g., ES modules, class fields). ↓

fix Consider migrating to more modern documentation tools like `ember-cli-addon-docs` or `JSDoc`/`ESDoc` directly, which have better support for contemporary JavaScript and Ember-specific paradigms.

deprecated The Ember ecosystem has largely moved away from YUIDoc for API documentation. The current recommended approach for Ember CLI addons and applications is `ember-cli-addon-docs`, which provides a more integrated and feature-rich documentation experience. ↓

fix Evaluate adopting `ember-cli-addon-docs` for new projects or refactoring existing documentation to use it for better long-term support and feature sets.

gotcha This theme package (`yuidoc-ember-cli-theme`) is unmaintained, with its last activity on GitHub dating back to late 2016. This means it will not receive updates for bugs, security vulnerabilities, or compatibility with newer Ember or Node.js versions. ↓

fix Use with caution in legacy projects. For new development, strongly consider alternatives that are actively maintained.

Install

npm install yuidoc-ember-cli-theme

yarn add yuidoc-ember-cli-theme

pnpm add yuidoc-ember-cli-theme

Imports

Theme Configuration
```
{ "themedir": "node_modules/yuidoc-ember-cli-theme", "helpers": ["node_modules/yuidoc-ember-cli-theme/helpers.js"] }
```
This package provides a theme and helpers for YUIDoc, which are configured via the `yuidoc.json` file. It does not expose JavaScript modules for direct import using `import` or `require` statements in application code.

Quickstart

Demonstrates the `yuidoc.json` configuration required to use the theme and the command to generate documentation.

{
  "name": "my-ember-app",
  "version": "0.0.1",
  "description": "My Ember CLI Application",
  "options": {
    "paths": ["app", "addon"],
    "exclude": "vendor,tests",
    "outdir": "docs"
  },
  "themedir": "node_modules/yuidoc-ember-cli-theme",
  "helpers": ["node_modules/yuidoc-ember-cli-theme/helpers.js"]
}

// To generate the documentation, run this command in your terminal:
// yuidoc