Versioned API Browser
This Ember Application allows you to browse API docs.
Setup
- Install Dependencies
npm install && bower install
-
Install
yuidocjs
(if needed) on your machine (npm -g install yuidocjs
) and run it in the root of your ember.js folder (yuidoc .
) -
Start the app with the following command args
-
lib-dir
(path) local path to the library documented with YUIDoc e.g./usr/yourname/code/ember.js
-
execution-dir
(path, defaultlib-dir
) local path to the directory whereyuidoc
should execute: e.g.'/usr/yourname/code/ember.js/docs'
-
project-name
(string, default''
) the name of the project you're documenting. this becomes the project's slug for urls: e.g.ember.js
becomes/ember.js/v1.9.0
-
default-index
(string) name of the class you'd like to redirect to when someone visits the root (/
) of the documentation. e.g.Ember
-
default-module
(string) name of the module where to look for module related data. YUIDoc stuffs all modules (even if you only have one) intomodules
: e.g.ember
-
rev
(string, optional, defaults to 'master') name of the revision you are generating: e.g.v1.1.0
-
sha
(String, optional, defaults to 'master') name of the SHA or tag. This is different thanrev
to allow you to publish new versions of a rev's docs that have been updated in future commits. So, if spelling fixes occur in commits > v1.1.0 and < v1.1.1 you can publish the SHA to update: e.g.decafbebad01
orv1.0.0
-
github-url
(url) github url of the project, no trailing slash: e.g. 'https://github.com/emberjs/ember.js'
ember server \
--lib-dir=/Users/trek/Development/ember/ember.js \
--default-index=Ember \
--default-module=ember \
--github-url=https://github.com/emberjs/ember.js \
--rev=v1.6.0 \
--environment=production \
--project-name=ember.js \
--execution-dir=/Users/trek/Development/ember/ember.js/docs
- View the app
open http://0.0.0.0:4200/<project-name>/<value for rev argument>/