Skip to content

Commit 2b28d95

Browse files
committed
[CLEANUP] Fix jsdoc formatting, add docs npm script.
1 parent 3fe5b35 commit 2b28d95

File tree

21 files changed

+258
-142
lines changed

21 files changed

+258
-142
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,6 @@ keys.txt
5050
export.sh
5151
dist/
5252
tmp/
53+
docs/
5354

5455
server.sh

.jsdoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"source": {
3+
"include": ["./src/js"]
4+
},
5+
"opts": {
6+
"readme": "./README.md",
7+
"recurse": true,
8+
"destination": "./docs"
9+
},
10+
"plugins": [
11+
"plugins/markdown"
12+
]
13+
}

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
"build": "rm -rf dist && broccoli build dist",
1111
"build-website": "./bin/build-website.sh",
1212
"deploy-website": "./bin/deploy-website.sh",
13-
"update-changelog": "./node_modules/conventional-changelog-cli/cli.js -i CHANGELOG.md -r 0 -s && git add CHANGELOG.md && git commit -m 'Update changelog'"
13+
"update-changelog": "conventional-changelog -i CHANGELOG.md -r 0 -s && git add CHANGELOG.md && git commit -m 'Update changelog'",
14+
"docs": "jsdoc -c ./.jsdoc"
1415
},
1516
"keywords": [
1617
"html",
@@ -47,6 +48,7 @@
4748
"conventional-changelog": "^1.1.0",
4849
"conventional-changelog-cli": "^1.1.1",
4950
"jquery": "^2.2.2",
51+
"jsdoc": "^3.4.0",
5052
"saucie": "^1.4.0",
5153
"testem": "^1.6.0"
5254
},

0 commit comments

Comments
 (0)