https://github.com/robdel12/ember-api
https://github.com/robdel12/ember-api
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/robdel12/ember-api
- Owner: Robdel12
- Created: 2015-01-14T15:13:34.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-01-14T14:44:32.000Z (over 11 years ago)
- Last Synced: 2025-07-20T09:11:44.092Z (12 months ago)
- Language: CSS
- Size: 694 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Versioned API Browser
This Ember Application allows you to browse API docs.
# Setup
1. Install Dependencies
```shell
npm install && bower install
```
1. Start the app with with the following command args
* `lib-dir` (path) local path to the library documented with YUIDoc
e.g. `/usr/yourname/code/ember.js`
* `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) into
`modules`: 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
than `rev` to allow you to publish new versions of a rev's docs that have been updated
in future commits. So, if a spelling fixes occur in commits > v1.1.0 and < v1.1.1 you
can publish the SHA to update: e.g. `decafbebad01` or `v1.0.0`
* `github-url (url) github url of the project, no trailing slash: e.g. 'https://github.com/emberjs/ember.js'
```shell
ember server --lib-dir=/path/to/ember.js --default-index=Ember --default-module=ember --rev=v1.0.0
```
1. View the app
```shell
open http://0.0.0.0:4200
```