Skip to content

Commit

Permalink
chore(build): add doc scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
alyec committed Nov 25, 2016
1 parent 79d7e25 commit df24bba
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"source": {
"includePattern": ".+\\.js(doc)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"plugins": [ "plugins/markdown" ],
"templates": {
"cleverLinks": false,
"monospaceLinks": false
}
}
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"del": "^2.0.2",
"dgeni": "^0.4.1",
"dgeni-packages": "^0.11.1",
"docdash": "https://github.com/alyec/docdash#master",
"gulp": "^3.9.0",
"gulp-babel": "^5.2.1",
"gulp-concat": "^2.6.0",
Expand All @@ -33,6 +34,8 @@
"gulp-tar": "^1.5.0",
"gulp-uglify": "~1.4.1",
"gulp-zip": "^3.0.2",
"http-server": "^0.6.1",
"jsdoc": "^3.4.0",
"jshint-stylish": "^2.0.1",
"lodash": "^3.10.1",
"proj4": "^2.3.12",
Expand All @@ -48,6 +51,8 @@
"yargs": "^5.0.0"
},
"scripts": {
"doc": "./node_modules/.bin/jsdoc -p -r -c .jsdoc.json -t node_modules/docdash -R README.md -d ./docbuild -u ./docs/content ./src",
"servedoc": "npm run doc && ./node_modules/.bin/http-server -p 6004 ./docbuild",
"test": "gulp test"
},
"repository": {
Expand Down

0 comments on commit df24bba

Please sign in to comment.