Skip to content
This repository has been archived by the owner on Apr 9, 2024. It is now read-only.

Generate dash docsets from YUI Documentation

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

jschilli/ember-cli-dash-docset

Repository files navigation

It's been a minute... No longer maintaining this so changing status to public archive...

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

About

Generate dash docsets from YUI Documentation

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published