ember-cli-dash-docset

0.1.1 • Public • Published

Ember-cli-dash-docset Build Status

Generates Dash docs from YUIDoc output for ember-cli apps

See also: ember-cli-yuidoc

YUIDocs should be generated prior to running

Demo

Install

ember install:npm ember-cli-dash-docset

Configuration

dashdoc.json contains directives that control the generated docset

{
  "name": "docset-data", <---- output docset name
  "outdir": "docset",    <---- where to put it
  "input": "docs",       <---- where to get the YUI generated docs
  "icon": "tests/fixtures/icon.png", <--- Optional image (32x32 png) 
  "dash": {
    "bundleIdentifier": "sample", 
    "bundleName": "sample",
    "docSetFamily": "sample",
    "docSetPlatformFamily": "sample",
    "docSetIndexPath": "index.html"
  }
}

Running

ember ember-cli-dash-docset

Contributing

PRs accepted

should pass jshint . and have tests

Running Tests

  • npm test

Package Sidebar

Install

npm i ember-cli-dash-docset

Weekly Downloads

1

Version

0.1.1

License

MIT

Last publish

Collaborators

  • jschilli