diff --git a/.jsdoc.json b/.jsdoc.json new file mode 100644 index 00000000..7b7708e0 --- /dev/null +++ b/.jsdoc.json @@ -0,0 +1,15 @@ +{ + "tags": { + "allowUnknownTags": true, + "dictionaries": ["jsdoc","closure"] + }, + "source": { + "includePattern": ".+\\.js(doc)?$", + "excludePattern": "(^|\\/|\\\\)_" + }, + "plugins": [ "plugins/markdown" ], + "templates": { + "cleverLinks": false, + "monospaceLinks": false + } +} diff --git a/package.json b/package.json index 96524fa1..5825a42b 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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", @@ -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": {