Skip to content
This repository was archived by the owner on Apr 12, 2022. It is now read-only.

Commit 08b00f1

Browse files
committed
Setup jsdoc generator and deploy script
1 parent 8b089d2 commit 08b00f1

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
dist/
2+
docs/
23
node_modules/
34
npm-debug.log

conf.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"templates": {
3+
"systemName": "Dropbox JavaScript SDK",
4+
"theme": "cosmo"
5+
}
6+
}

package.json

+5
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
"build-cjs": "webpack",
99
"build-umd": "webpack -p --config webpack-umd.config.js",
1010
"compressed-size": "echo 'dropbox-sdk.min.js gzipped will weigh' $(cat dist/dropbox-sdk.min.js | gzip -9 | wc -c | pretty-bytes)",
11+
"publish-docs": "rm -rf docs && npm run generate-docs && gh-pages -d docs",
12+
"generate-docs": "jsdoc -c ./conf.json -d docs -t ./node_modules/ink-docstrap/template -R README.md -r ./src",
1113
"lint": "eslint src",
1214
"start": "node examples/server.js",
1315
"test": "npm run lint && mocha 'test/*.js'"
@@ -24,6 +26,9 @@
2426
"eslint-config-airbnb": "^6.2.0",
2527
"express": "^4.13.4",
2628
"express-urlrewrite": "^1.2.0",
29+
"gh-pages": "^0.11.0",
30+
"ink-docstrap": "^1.2.1",
31+
"jsdoc": "^3.4.0",
2732
"mocha": "^2.4.5",
2833
"pretty-bytes": "^2.0.1",
2934
"prompt": "^1.0.0",

0 commit comments

Comments
 (0)