Skip to content

Commit

Permalink
[CLEANUP] Fix jsdoc formatting, add docs npm script.
Browse files Browse the repository at this point in the history
  • Loading branch information
bantic committed Apr 5, 2016
1 parent 3fe5b35 commit 2b28d95
Show file tree
Hide file tree
Showing 21 changed files with 258 additions and 142 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,6 @@ keys.txt
export.sh
dist/
tmp/
docs/

server.sh
13 changes: 13 additions & 0 deletions .jsdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"source": {
"include": ["./src/js"]
},
"opts": {
"readme": "./README.md",
"recurse": true,
"destination": "./docs"
},
"plugins": [
"plugins/markdown"
]
}
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"build": "rm -rf dist && broccoli build dist",
"build-website": "./bin/build-website.sh",
"deploy-website": "./bin/deploy-website.sh",
"update-changelog": "./node_modules/conventional-changelog-cli/cli.js -i CHANGELOG.md -r 0 -s && git add CHANGELOG.md && git commit -m 'Update changelog'"
"update-changelog": "conventional-changelog -i CHANGELOG.md -r 0 -s && git add CHANGELOG.md && git commit -m 'Update changelog'",
"docs": "jsdoc -c ./.jsdoc"
},
"keywords": [
"html",
Expand Down Expand Up @@ -47,6 +48,7 @@
"conventional-changelog": "^1.1.0",
"conventional-changelog-cli": "^1.1.1",
"jquery": "^2.2.2",
"jsdoc": "^3.4.0",
"saucie": "^1.4.0",
"testem": "^1.6.0"
},
Expand Down

0 comments on commit 2b28d95

Please sign in to comment.