Skip to content

Commit

Permalink
Add doc:live task
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyckahn committed Oct 9, 2017
1 parent bd43b34 commit 88f44be
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -48,6 +48,12 @@ To generate the documentation (`dist/doc`):
npm run doc
```

To generate, live-update, and view the documentation in your browser:

```
npm run doc:live
```

To start a development server:

```
Expand Down
5 changes: 5 additions & 0 deletions package.json
Expand Up @@ -14,9 +14,11 @@
"babel-loader": "^6.2.10",
"babel-preset-es2015": "^6.22.0",
"bluebird": "^3.5.0",
"concurrently": "^3.5.0",
"gh-pages": "^0.12.0",
"jsdoc": "^3.4.3",
"jshint": "^2.9.4",
"live-server": "^1.2.0",
"minami": "^1.2.3",
"mocha": "^3.2.0",
"nodemon": "^1.11.0",
Expand All @@ -29,6 +31,9 @@
"test": "mocha ./node_modules/babel-core/register.js test/index.js",
"test:watch": "nodemon --exec \"npm test\" --watch src --watch test",
"doc": "jsdoc -c .jsdoc src/*.js",
"doc:view": "live-server dist/doc --port=9124",
"doc:watch": "nodemon --exec \"npm run doc\" --watch src --watch ./ --ext js,md --ignore dist",
"doc:live": "concurrently --kill-others \"npm run doc:watch\" \"npm run doc:view\"",
"lint": "jshint src",
"deploy": "npm run build && npm run doc && gh-pages -d dist -b gh-pages",
"preversion": "npm run lint && npm test",
Expand Down

0 comments on commit 88f44be

Please sign in to comment.