https://github.com/cibernox/ember-cli-yuidoc

EmberCLI addon for generate documentation from YUIDoc coments
https://github.com/cibernox/ember-cli-yuidoc

Last synced: 14 days ago
JSON representation

EmberCLI addon for generate documentation from YUIDoc coments

• Host: GitHub
• URL: https://github.com/cibernox/ember-cli-yuidoc
• Owner: cibernox
• License: mit
• Created: 2014-10-22T23:22:37.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-11-02T16:12:48.000Z (about 5 years ago)
• Last Synced: 2024-12-10T08:42:27.036Z (24 days ago)
• Language: JavaScript
• Size: 83 KB
• Stars: 55
• Watchers: 6
• Forks: 25
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

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

```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: 

```json

{

  "name": "sample-app",

  "version": "1.2.3",

  "options": {

    "paths": ["app"],

    "exclude": "vendor",

    "outdir": "docs",

    "syntaxtype": "coffee",

    "extension": ".coffee"

  }

}

```