Skip to content
EmberCLI addon for generate documentation from YUIDoc coments
JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
addon Bumped to 0.1.4 Nov 4, 2014
app Initial Commit from Ember CLI v0.1.2 Oct 22, 2014
blueprints constently load all options Dec 30, 2015
config Install ember-cli-release Jul 12, 2015
lib Handle decorators in codeblocks Nov 2, 2019
tests Update to ember-cli 0.2.3 May 10, 2015
vendor Initial Commit from Ember CLI v0.1.2 Oct 22, 2014
.bowerrc Initial Commit from Ember CLI v0.1.2 Oct 22, 2014
.editorconfig Update to ember-cli 0.2.3 May 10, 2015
.ember-cli Initial Commit from Ember CLI v0.1.2 Oct 22, 2014
.gitignore
.jshintrc Update to ember-cli 0.2.0 Mar 21, 2015
.npmignore Update to ember-cli 0.2.3 May 10, 2015
.travis.yml Update to ember-cli 0.2.3 May 10, 2015
Brocfile.js Update to ember-cli 0.2.0 Mar 21, 2015
CHANGELOG.md Update changelog Jul 28, 2015
LICENSE.md
README.md
bower.json
index.js
package.json v0.9.1 Nov 2, 2019
testem.json Update to ember-cli 0.2.0 Mar 21, 2015

README.md

Ember-cli-yuidoc

This is an ember-cli addon for generate html documentation from YUIDoc comments in the source code.

Installation

If you're using ember-cli > 0.1.5, you can just run ember install ember-cli-yuidoc and you're done.

If you are using an older version, first install the addon from npm with npm install --save-dev ember-cli-yuidoc.

Then, you need to add a yuidoc.json manifest on the root of your project. Run ember g ember-cli-yuidoc to generate once with some sensible defaults.

Usage

As an ember command

This addon adds a new ember-cli-yuidoc command to ember-cli to generate the documentation on demand.

Just run ember ember-cli-yuidoc and your docs will apear in your output directory (/docs by default). You probably want to add this folder to the .gitignore.

Watch mode

This plugin also integrates with the ember server, so you can access your docs from the browser in the /docs urls. The documentation will update when you modify your code, as expected.

While this is specially useful if your are editing your documentation, it adds some overhead to your build pipeline, so this is disabled by default. Run ember serve --docs to enable it.

Environment specific generation

This plugin supports the ability to force generate your documentation via the enabledEnvironments option that may be defined in your yuidoc.json.

{
  "name": "sample-app",
  "version": "1.2.3",
  "options": {
    "enabledEnvironments": ["development", "production"]
  }
}

This will generate your documentation when using ember build ember build --environment=production ember s and so on without needing to use --docs.

Like coffescript? It's ok.

The plugin supports coffescript out of the box. In your application's yuidoc.json you can configure the syntaxtype and extension like this:

{
  "name": "sample-app",
  "version": "1.2.3",
  "options": {
    "paths": ["app"],
    "exclude": "vendor",
    "outdir": "docs",
    "syntaxtype": "coffee",
    "extension": ".coffee"
  }
}
You can’t perform that action at this time.