Skip to content

Commit 2a18d51

Browse files
committed
Moves YUIDoc parsing into an ember-cli addon.
1 parent c561195 commit 2a18d51

File tree

10 files changed

+6
-18634
lines changed

10 files changed

+6
-18634
lines changed

.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# See http://help.github.com/ignore-files/ for more about ignoring files.
22

3-
# generated docs
4-
/tasks/docs
5-
63
# compiled output
74
/dist
85
/tmp

README.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Versioned API Browser
2-
This Ember Application allows you to browse API docs
2+
This Ember Application allows you to browse API docs.
3+
34

45
# Setup
56

@@ -9,17 +10,10 @@ This Ember Application allows you to browse API docs
910
npm install && bower install
1011
```
1112

12-
1. Generate Documentation JSON
13-
14-
```shell
15-
mkdir -p tasks/docs
16-
node tasks/generate-docs.js
17-
```
18-
19-
1. Start the app
13+
1. Start the app with an environemt variable pointing towards a library documented with YUIDoc
2014

2115
```shell
22-
ember server
16+
YUIDOC_LIB_DIR=/path/to/ember.js ember server
2317
```
2418

2519
1. View the app

package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
"ember-export-application-global": "^1.0.0",
3131
"express": "^4.8.5",
3232
"glob": "^4.0.5",
33-
"highlight.js": "^8.4.0",
34-
"marked": "^0.3.2"
33+
"ember-cli-yuidoc-converter" : "git://github.com/trek/ember-cli-yuidoc-converter.git#1.0.0"
3534
}
3635
}

server/mocks/docs.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ module.exports = function(app) {
44
var express = require('express');
55
var docRouter = express.Router();
66
docRouter.get('*', function(req, res) {
7-
var path = __dirname + '/../../tasks/docs' + req.path;
7+
var path = __dirname + '/../../dist/docs' + req.path;
88
var stream = fs.createReadStream(path);
99
stream.on('error', function(e){
1010
res.status(404).send('not found');

0 commit comments

Comments
 (0)